基本信息
获取指定任务taskId的候选用户和组的列表。
请求方式 GET
请求API GET / tasks / {taskId} / candidates
响应等级(状态200)
成功回应
{ "list": { "pagination": { "count": 0, "hasMoreItems": true, "totalItems": 0, "skipCount": 0, "maxItems": 0 }, "entries": [ { "entry": { "candidateType": "user", "candidateId": "string" } } ] } }
响应内容类型 applicaiton/json
Query参数
名称 | 类型 | 是否必填 | 示例值 | 描述 |
skipCount | integer | 否 | 在list中跳过指定数量的数据。 | |
maxItems | integer | 否 | 在list中要返回的最大项目数。 | |
properties | Array[string] | 否 | 属性名称列表。 您可以使用properties参数来限制返回的属性数。 |
Path参数
名称 | 类型 | 是否必填 | 示例值 | 描述 |
taskId | string | 是 | 任务的标识符。 |
错误信息描述
状态码 | 原因 |
400 | 参数无效:maxItems或skipCount的值无效 |
401 | 验证失败 |
404 | taskId不存在 |
default | 意外错误 |
返回结果示例
{ "error": { "errorKey": "string", "statusCode": 0, "briefSummary": "string", "stackTrace": "string", "descriptionURL": "string", "logId": "string" } }