文档 API参考

包

Bundle是对组成您的集成的ZIS资源的声明，例如flow、Action亚博电脑端定义和jobspec。

JSON格式

bundle被表示为具有以下属性的JSON对象:

名字 类型 只读 强制性的 描述
描述 字符串 真正的 假 Bundle的描述
名字 字符串 假 真正的 Bundle的名称
亚博电脑端 对象 真正的 真正的 ZIS资源的集合亚博电脑端
zis_template_version 字符串 假 真正的 ZIS Bundle模板版本。“2019-10-14”的允许值。

上传或更新包

  • POST / api /服务/子/注册/{集成}/包

上传一个新的bundle或更新一个现有的bundle到ZIS Registry。

身份验证

可以使用基本身份验证或API令牌对请求进行授权。

允许

  • 管理员

删除bundle

你不能删除一个bundle。要禁用集成，请卸载其JobSpec。看到卸载JobSpec端点。

参数

名字 类型 在 要求 描述
集成 字符串 路径 真正的 集成的名称。集成最长可达64个字符。只能包含小写字母(a-z)、数字、划线(-)和下划线(_)

例子的身体

             

              
｛“描述”："这是一个示例包"，“名称”：“包”，“亚博电脑端资源”：｛“example_flow”：｛“属性”：｛“定义”：｛“StartAt”：“HelloWorld”，“州”：｛“HelloWorld”：｛“结束”：真正的，“结果”：“Hello World !”，“ResultPath”：“.messages美元”，“类型”：“通过”}}}，“名称”：“my_flow”}，“类型”：“子:流”}，“example_job_spec”：｛“属性”：｛“event_source”：“支持”，“event_type”：”票。TicketCreated”，“flow_name”：“子:例如:流:my_flow”，“名称”：“my_job_Spec”}，“类型”：“子::JobSpec”}}，“zis_template_version”：“2019-10-14”}

代码示例

旋度 
              

               
旋度https://｛子域名}.亚博zendesk.com/api/services/zis/registry/｛集成}/包＼- u｛email_address}：｛密码}＼- x的帖子＼- h“application / json内容类型:＼- d @bundle.json
去 
              

               
进口（“fmt”“输入输出”“net/http”“弦”）函数主要（）｛url: =“https://support.亚博zendesk.com/api/services/zis/registry/my_integration/bundles”方法: =“职位”有效载荷: =字符串．NewReader（”{"description": "这是一个示例包"，"name": "example bundle";"亚博电脑端资源":{" example_flow ": {"属性":{"定义":{“StartAt”:“HelloWorld”,“状态”:{“HelloWorld”:{“结束”:没错,"Result": "Hello World!"，:“ResultPath .messages美元”,“类型”:“通过”}}}，“名称”:“my_flow”}，“类型”:“子:流”}，" example_job_spec ": {"属性":{“event_source”:“支持”,:“event_type票。TicketCreated”,“flow_name”:“子:例如:流:my_flow”,“名称”:“my_job_Spec”}，“类型”:“子::JobSpec”}}，“zis_template_version”:“2019-10-14”} '）要求的事情，犯错: =http．NewRequest（方法，url，有效载荷）如果犯错! =零｛fmt．Println（犯错）返回}要求的事情．头．添加（“内容类型”，“application / json”）要求的事情．头．添加（“授权”，“基本< auth-value >”）// Base64编码的"username:password"客户端: =＆http．客户端｛}res，犯错: =客户端．做（要求的事情）如果犯错! =零｛fmt．Println（犯错）返回}推迟res．身体．关闭（）身体，犯错: =io．ReadAll（res．身体）如果犯错! =零｛fmt．Println（犯错）返回}fmt．Println（字符串（身体））}
Java 
              

               
进口com．squareup．okhttp．＊；OkHttpClient客户端＝新OkHttpClient（）；HttpUrl．构建器urlBuilder＝HttpUrl．解析（“https://support.亚博zendesk.com/api/services/zis/registry/my_integration/bundles”）．newBuilder（）；RequestBody身体＝RequestBody．创建（MediaType．解析（“application / json”），”“＂｛\ \“描述”：\”这是一个示例包\"，\“\”：包\ \“例子”，\ 亚博电脑端\“资源”：｛example_flow \“\”：｛\ \“属性”：｛\“\”的定义：｛\”StartAt\”：\”HelloWorld\”，\”州\”：｛\”HelloWorld\”：｛\”结束\”：真正的，\”结果\”：\”你好世界！\”，\”ResultPath\”：\ " $．消息\”，\”类型\”：\”通过\”}}}，\“\”：my_flow \“\”}，\”类型\”：\”子：：流\”}，example_job_spec \“\”：｛\ \“属性”：｛event_source \“\”：\“支持\”，event_type \“\”：\“票．TicketCreated\”，flow_name \“\”：\”子：例子：流：my_flow \”，\“\”：my_job_Spec \“\”}，\”类型\”：\”子：：JobSpec\”}}，zis_template_version \“\”：\”2019-10-14\”}”“＂）；请求请求＝新请求．构建器（）．url（urlBuilder．构建（））．方法（“职位”，身体）．addHeader（“内容类型”，“application / json”）．addHeader（“授权”，凭证．基本（“电子邮件”，“你的密码”））．构建（）；响应响应＝客户端．newCall（请求）．执行（）；
Nodejs 
              

               
varaxios＝需要（“axios”）；var数据＝JSON．stringify（｛“描述”："这是一个示例包"，“名称”：“包”，“亚博电脑端资源”：｛“example_flow”：｛“属性”：｛“定义”：｛“StartAt”：“HelloWorld”，“州”：｛“HelloWorld”：｛“结束”：真正的，“结果”：“Hello World !”，“ResultPath”：“.messages美元”，“类型”：“通过”}}}，“名称”：“my_flow”}，“类型”：“子:流”}，“example_job_spec”：｛“属性”：｛“event_source”：“支持”，“event_type”：”票。TicketCreated”，“flow_name”：“子:例如:流:my_flow”，“名称”：“my_job_Spec”}，“类型”：“子::JobSpec”}}，“zis_template_version”：“2019-10-14”}）；var配置＝｛方法：“职位”，url：“https://support.亚博zendesk.com/api/services/zis/registry/my_integration/bundles”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"}，数据：数据，}；axios（配置）．然后（函数（响应）｛控制台．日志（JSON．stringify（响应．数据））；}）．抓（函数（错误）｛控制台．日志（错误）；}）；
Python 
              

               
进口请求进口jsonurl＝“https://support.亚博zendesk.com/api/services/zis/registry/my_integration/bundles”有效载荷＝json．加载（”““{"description": "这是一个示例包"，"name": "example bundle";"亚博电脑端资源":{" example_flow ": {"属性":{"定义":{“StartAt”:“HelloWorld”,“状态”:{“HelloWorld”:{“结束”:没错,"Result": "Hello World!"，:“ResultPath .messages美元”,“类型”:“通过”}}}，“名称”:“my_flow”}，“类型”:“子:流”}，" example_job_spec ": {"属性":{“event_source”:“支持”,:“event_type票。TicketCreated”,“flow_name”:“子:例如:流:my_flow”,“名称”:“my_job_Spec”}，“类型”:“子::JobSpec”}}，“zis_template_version”:“2019-10-14”}”“”）头＝｛“内容类型”：“application / json”，}响应＝请求．请求（“职位”，url，身份验证＝（“<用户名>”，' <密码> '），头＝头，json＝有效载荷）打印（响应．文本）
鲁比（人名） 
              

               
需要“net/http”uri＝URI（“https://support.亚博zendesk.com/api/services/zis/registry/my_integration/bundles”）请求＝网：：HTTP：：帖子．新（uri，“内容类型”：“application / json”）请求．身体＝％问（｛“描述”："这是一个示例包"，“名称”：“包”，“亚博电脑端资源”：｛“example_flow”：｛“属性”：｛“定义”：｛“StartAt”：“HelloWorld”，“州”：｛“HelloWorld”：｛“结束”：真正的，“结果”：“Hello World !”，“ResultPath”：“.messages美元”，“类型”：“通过”}}}，“名称”：“my_flow”}，“类型”：“子:流”}，“example_job_spec”：｛“属性”：｛“event_source”：“支持”，“event_type”：”票。TicketCreated”，“flow_name”：“子:例如:流:my_flow”，“名称”：“my_job_Spec”}，“类型”：“子::JobSpec”}}，“zis_template_version”：“2019-10-14”}）请求．basic_auth“用户名”，“密码”响应＝网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束

示例响应(年代)

200好了 
              

               
//状态200 OK零
400错误请求 
              

               
//状态400错误请求｛“错误”：［｛“代码”：“1010”，“细节”：“错误信息”，“状态”：“400”}]，“消息”：“未经授权的”}
401年未经授权 
              

               
//状态401未授权｛“错误”：［｛“代码”：“1001”，“细节”：“错误信息”，“状态”：“401”}]，“消息”：“未经授权的”}
500服务器内部错误 
              

               
//状态500服务器内部错误｛“错误”：［｛“代码”：“1050”，“细节”：“错误信息”，“状态”：“500”}]，“消息”：“服务器错误”}