文档 API参考

工作状态

状态记录是在某人开始工作时创建的，例如更新多个票证。您可以在创建特定作业后的一天内访问作业状态数据，之后该数据将不再可用。

JSON格式

作业状态表示为具有以下属性的JSON对象:

名字 类型 只读 强制性的 描述
id 字符串 真正的 假 在作业排队时自动分配
消息 字符串 真正的 假 来自作业工作者的消息(如果有的话)
进步 整数 真正的 假 已经完成的任务数
结果 真正的 假 已处理任务的结果数据。看到结果下面
状态 字符串 真正的 假 当前状态。下列情况之一:"排队"、"工作中"、"失败"、"完成"
总计 整数 真正的 假 此作业正在批处理的任务总数
url 字符串 真正的 假 轮询状态更新的URL

结果

响应中的“results”数组列出了处理后成功和不成功更新或创建的资源。亚博电脑端

结果因工作类型而异。

永久删除票证

如果作业是永久删除票据，则结果是一个对象，该对象只指定是否成功删除了所有票据(“成功”:没错)。

             

              
｛“job_status”：｛“id”：“dd9321f29967688b27bc9499ebb4ae8d”，“url”：“https://example.亚博zendesk.com/api/v2/job_statuses/dd9321f299676c9499ebb4ae8d.json”，“总”：零，“进步”：零，“状态”：“完成”，“消息”：完成于2018-03-08 06:07:49 +0000，“结果”：｛“成功”：真正的}}}

批量创建

如果作业是批量创建资源，则每个结果指定以下内容:亚博电脑端

  • 新资源的id (“id”:245）
  • 结果的索引号(“指数”:1）

例子

             

              
｛“job_status”：｛“id”：“dd9321f29967688b27bc9499ebb4ae8d”，“url”：“https://example.亚博zendesk.com/api/v2/job_statuses/dd9321f299676c9499ebb4ae8d.json”，“总”：2，“进步”：2，“状态”：“完成”，“消息”：完成于2018-03-08 06:07:49 +0000，“结果”：［｛“id”：244，“指数”：0}，｛“id”：245，“指数”：1}]}}

批量更新

如果作业是批量更新资源，则每个结果指定以下内容:亚博电脑端

  • 作业试图更新的资源id (“id”:255）
  • 工作尝试执行的操作(“行动”:“更新”）
  • 行动是否成功(“成功”:没错）
  • 状态(“状态”:“更新”）

例子

             

              
｛“id”：“82 de0b044094f0c67893ac9fe64f1a99”，“消息”：完成时间:2018-03-08 10:07:04 +0000，“进步”：2，“结果”：［｛“行动”：“更新”，“id”：244，“状态”：“更新”，“成功”：真正的}，｛“行动”：“更新”，“id”：245，“状态”：“更新”，“成功”：真正的}]，“状态”：“完成”，“总”：2，“url”：“https://example.亚博zendesk.com/api/v2/job_statuses/82de0b0467893ac9fe64f1a99.json”}

列出作业状态

  • GET / api / v2 / job_statuses

显示后台作业的状态。

允许:

  • 代理

分页

  • 光标分页

看到分页。

返回按排序的每页最多100条记录Completed_at desc, created_at desc。不允许任何其他排序顺序。

代码示例

旋度 
              

               
旋度https://｛子域名}.亚博zendesk.com/api/v2/job_statuses.json＼- v - u｛email_address}：｛密码}
去 
              

               
进口（“fmt”“输入输出”“net/http”）函数主要（）｛url：=“https://example.亚博zendesk.com/api/v2/job_statuses”方法：=“获得”要求的事情，犯错：=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://example.亚博zendesk.com/api/v2/job_statuses”）。newBuilder（）；请求请求=新请求。构建器（）。url（urlBuilder。构建（））。方法（“获得”，零）。addHeader（“内容类型”，“application / json”）。addHeader（“授权”，凭证。基本（“电子邮件”，“你的密码”））。构建（）；响应响应=客户端。newCall（请求）。执行（）；
Nodejs 
              

               
varaxios=需要（“axios”）；var配置=｛方法：“得到”，url：“https://example.亚博zendesk.com/api/v2/job_statuses”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"}，}；axios（配置）。然后（函数（响应）｛控制台。日志（JSON。stringify（响应。数据））；}）。抓（函数（错误）｛控制台。日志（错误）；}）；
Python 
              

               
进口请求url=“https://example.亚博zendesk.com/api/v2/job_statuses”头=｛“内容类型”：“application / json”，}响应=请求。请求（“获得”，url，身份验证=（“<用户名>”，' <密码> '），头=头）打印（响应。文本）
鲁比（人名） 
              

               
需要“net/http”uri=URI（“https://example.亚博zendesk.com/api/v2/job_statuses”）请求=网：：HTTP：：得到。新（uri，“内容类型”：“application / json”）请求。basic_auth“用户名”，“密码”响应=网：：HTTP。开始uri。主机名，uri。港口，use_ssl：真正的做|http|http。请求（请求）结束

示例响应(年代)

200好了 
              

               
//状态200 OK｛“job_statuses”：［｛“id”：“8 b726e606741012ffc2d782bcb7848fe”，“状态”：“完成”}，｛“id”：“e7665094164c498781ebe4c8db6d2af5”，“状态”：“完成”}]}

显示多个工作状态

  • GET / api / v2 / job_statuses / show_many吗?id = {id}

接受以逗号分隔的作业状态id列表。

允许:

  • 代理

参数

名字 类型 在 要求 描述
id 字符串 查询 真正的 以逗号分隔的作业状态id列表。

代码示例

旋度 
              

               
旋度https://｛子域名}i亚博ds .zendesk.com/api/v2/job_statuses/show_many.json吗?=8 b726e606741012ffc2d782bcb7848fe 8 b726e606741012ffc2d782bcb7848fe e7665094164c498781ebe4c8db6d2af5＼- v - u｛email_address}：｛密码}
去 
              

               
进口（“fmt”“输入输出”“net/http”）函数主要（）｛url：=“https://example.亚博zendesk.com/api/v2/job_statuses/show_many?ids=8b726e606741012ffc2d782bcb7848fe%2Ce7665094164c498781ebe4c8db6d2af5”方法：=“获得”要求的事情，犯错：=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://example.亚博zendesk.com/api/v2/job_statuses/show_many”）。newBuilder（）。addQueryParameter（“id”，“8 b726e606741012ffc2d782bcb7848fe e7665094164c498781ebe4c8db6d2af5”）；请求请求=新请求。构建器（）。url（urlBuilder。构建（））。方法（“获得”，零）。addHeader（“内容类型”，“application / json”）。addHeader（“授权”，凭证。基本（“电子邮件”，“你的密码”））。构建（）；响应响应=客户端。newCall（请求）。执行（）；
Nodejs 
              

               
varaxios=需要（“axios”）；var配置=｛方法：“得到”，url：“https://example.亚博zendesk.com/api/v2/job_statuses/show_many”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"}，参数个数：｛“id”：“8 b726e606741012ffc2d782bcb7848fe % 2 ce7665094164c498781ebe4c8db6d2af5”，}，}；axios（配置）。然后（函数（响应）｛控制台。日志（JSON。stringify（响应。数据））；}）。抓（函数（错误）｛控制台。日志（错误）；}）；
Python 
              

               
进口请求url=“https://example.亚博zendesk.com/api/v2/job_statuses/show_many?ids=8b726e606741012ffc2d782bcb7848fe%2Ce7665094164c498781ebe4c8db6d2af5”头=｛“内容类型”：“application / json”，}响应=请求。请求（“获得”，url，身份验证=（“<用户名>”，' <密码> '），头=头）打印（响应。文本）
鲁比（人名） 
              

               
需要“net/http”uri=URI（“https://example.亚博zendesk.com/api/v2/job_statuses/show_many”）uri。查询=URI。encode_www_form（“id”：“8 b726e606741012ffc2d782bcb7848fe e7665094164c498781ebe4c8db6d2af5”）请求=网：：HTTP：：得到。新（uri，“内容类型”：“application / json”）请求。basic_auth“用户名”，“密码”响应=网：：HTTP。开始uri。主机名，uri。港口，use_ssl：真正的做|http|http。请求（请求）结束

示例响应(年代)

200好了 
              

               
//状态200 OK｛“job_statuses”：［｛“id”：“8 b726e606741012ffc2d782bcb7848fe”，“状态”：“完成”}，｛“id”：“e7665094164c498781ebe4c8db6d2af5”，“状态”：“完成”}]}

显示作业状态

  • GET / api / v2 / job_statuses / {job_status_id}

显示后台任务的状态。

允许:

  • 代理

参数

名字 类型 在 要求 描述
job_status_id 字符串 路径 真正的 Job状态Id

代码示例

旋度 
              

               
旋度https://｛子域名}.亚博zendesk.com/api/v2/job_statuses/｛job_status_id}. json＼- v - u｛email_address}：｛密码}
去 
              

               
进口（“fmt”“输入输出”“net/http”）函数主要（）｛url：=“https://example.亚博zendesk.com/api/v2/job_statuses/8b726e606741012ffc2d782bcb7848fe”方法：=“获得”要求的事情，犯错：=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://example.亚博zendesk.com/api/v2/job_statuses/8b726e606741012ffc2d782bcb7848fe”）。newBuilder（）；请求请求=新请求。构建器（）。url（urlBuilder。构建（））。方法（“获得”，零）。addHeader（“内容类型”，“application / json”）。addHeader（“授权”，凭证。基本（“电子邮件”，“你的密码”））。构建（）；响应响应=客户端。newCall（请求）。执行（）；
Nodejs 
              

               
varaxios=需要（“axios”）；var配置=｛方法：“得到”，url：“https://example.亚博zendesk.com/api/v2/job_statuses/8b726e606741012ffc2d782bcb7848fe”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"}，}；axios（配置）。然后（函数（响应）｛控制台。日志（JSON。stringify（响应。数据））；}）。抓（函数（错误）｛控制台。日志（错误）；}）；
Python 
              

               
进口请求url=“https://example.亚博zendesk.com/api/v2/job_statuses/8b726e606741012ffc2d782bcb7848fe”头=｛“内容类型”：“application / json”，}响应=请求。请求（“获得”，url，身份验证=（“<用户名>”，' <密码> '），头=头）打印（响应。文本）
鲁比（人名） 
              

               
需要“net/http”uri=URI（“https://example.亚博zendesk.com/api/v2/job_statuses/8b726e606741012ffc2d782bcb7848fe”）请求=网：：HTTP：：得到。新（uri，“内容类型”：“application / json”）请求。basic_auth“用户名”，“密码”响应=网：：HTTP。开始uri。主机名，uri。港口，use_ssl：真正的做|http|http。请求（请求）结束

示例响应(年代)

200好了 
              

               
//状态200 OK｛“job_status”：｛“id”：“8 b726e606741012ffc2d782bcb7848fe”，“消息”：“完成于2012年4月13日星期五02:51:53 +0000”，“进步”：2，“结果”：［｛“行动”：“更新”，“id”：380，“状态”：“更新”，“成功”：真正的}]，“状态”：“完成”，“总”：2，“url”：“https://company.亚博zendesk.com/api/v2/job_statuses/8b726e606741012ffc2d782bcb7848fe.json”}}