Appearance
我发起的对外接口
基本信息
中文名: 我发起的对外接口
接口名: /tc/openapi/3rd/Inst/getList
所在目录: 待办
调用方式: GET(HTTPS)
| 最低可用版本 | V2.5.0 |
|---|
请求参数
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| userId | String | 是 | 发起人ID | |
| pageSize | Int | 是 | 页面大小 | |
| finishEndTime | Date | 否 | 完成时间end | |
| createStartTime | Date | 否 | 创建时间start | |
| createEndTime | Date | 否 | 创建时间end | |
| pageNo | Int | 是 | 页码 | |
| tenantId | String | 是 | 租户ID | |
| appKey | String | 否 | 应用key | |
| finishStartTime | Date | 否 | 完成时间end | |
| keyword | String | 否 | 关键字 | |
| status | Integer | 否 | 状态<br/>0-运行中;<br/>1-已撤销;<br/>2-已完成。 |
返回参数
| 字段名 | 类型 | 备注 |
|---|---|---|
| success | Boolean | 是否成功 |
| content | Object | 发起实例列表 |
Content
| 字段名 | 类型 | 备注 |
|---|---|---|
| totalSize | Integer | 总数 |
| data | List<TaskPackageDTO> | 发起实例列表 |
| success | Boolean | 是否成功 |
| responseCode | String | 响应码 |
| responseMessage | String | 响应参数 |
| currentPage | Integer | 当前页 |
| pageSize | Integer | 页面数 |
TaskPackageDTO
| 字段名 | 类型 | 备注 |
|---|---|---|
| appKey | String | 应用key |
| appName | String | 来源系统 |
| packageUuid | String | 实例uuid |
| creator | UserInfoDTO | 创建人,如下 |
| subject | String | 实例标题 |
| status | String | 实例状态<br/>0-运行中;<br/>1-已撤销;<br/>2-已完成。 |
| result | String | 完成结果 |
| url | String | 详情url |
| mobileUrl | String | 移动详情url |
| createTime | Date | 实例创建时间 |
| finishTime | Date | 实例完成时间 |
UserInfoDTO
| 字段名 | 类型 | 备注 |
|---|---|---|
| userId | String | 用户ID |
| name | String | 用户名 |
| imgId | String | 头像 |
调用示例
java
Map<String, String> parameter = new HashMap<>();
parameter.put("pageSize", "10");
parameter.put("finishEndTime", "2023-03-28");
parameter.put("userId", "603248");
parameter.put("createStartTime", "2023-03-28");
parameter.put("createEndTime", "2023-03-28");
parameter.put("pageNo", "1");
parameter.put("tenantId", "1");
parameter.put("appKey", "xxx");
parameter.put("finishStartTime", "2023-03-28");
parameter.put("keyword", "xxx");
parameter.put("status", "0");
//拼装业务信息
HttpParameters parameters = HttpParameters.builder()
.api("/tc/openapi/3rd/Inst/getList")
.region("INTER")
.accessKey("xxx")
.secretKey("xxx")
.queryParamsMap(parameter)
.requestUrl("https://api-one.digitalhainan.com.cn/apione")
.mediaType(MediaType.parse("application/json"))
.method("GET")
.build();
HttpReturn call = HttpCaller.getInstance().call(parameters);
log.info("响应:" + call.response);