107 lines
3.7 KiB
YAML
107 lines
3.7 KiB
YAML
|
openapi: 3.0.3
|
||
|
|
info:
|
||
|
|
title: 柏悦头程履约 API
|
||
|
|
version: 1.1.0
|
||
|
|
security:
|
||
|
|
- bearerAuth: []
|
||
|
|
paths:
|
||
|
|
/api/platform/v1/first-leg/tasks:
|
||
|
|
get:
|
||
|
|
summary: 分页查询履约任务
|
||
|
|
description: 需要 platform:firstleg:task:list 权限
|
||
|
|
parameters:
|
||
|
|
- $ref: '#/components/parameters/TenantId'
|
||
|
|
- $ref: '#/components/parameters/Page'
|
||
|
|
- $ref: '#/components/parameters/Size'
|
||
|
|
- {name: keyword, in: query, schema: {type: string, maxLength: 64}}
|
||
|
|
- {name: status, in: query, schema: {type: string, enum: [PENDING_ASSIGNMENT, ASSIGNED, PROCESSING, COMPLETED, CANCELLED]}}
|
||
|
|
- {name: assigneeId, in: query, schema: {type: integer, format: int64}}
|
||
|
|
responses:
|
||
|
|
'200': {description: 查询成功}
|
||
|
|
'403': {description: 无查询权限}
|
||
|
|
/api/platform/v1/first-leg/tasks/{taskId}:
|
||
|
|
get:
|
||
|
|
summary: 查询履约任务详情
|
||
|
|
description: 需要 platform:firstleg:task:view 权限
|
||
|
|
parameters:
|
||
|
|
- $ref: '#/components/parameters/TenantId'
|
||
|
|
- $ref: '#/components/parameters/TaskId'
|
||
|
|
responses:
|
||
|
|
'200': {description: 查询成功}
|
||
|
|
'403': {description: 无查看权限}
|
||
|
|
'404': {description: 任务不存在}
|
||
|
|
/api/platform/v1/first-leg/tasks/by-order/{orderId}:
|
||
|
|
get:
|
||
|
|
summary: 按订单查询履约任务
|
||
|
|
description: 需要 platform:firstleg:task:view 权限
|
||
|
|
parameters:
|
||
|
|
- $ref: '#/components/parameters/TenantId'
|
||
|
|
- {name: orderId, in: path, required: true, schema: {type: integer, format: int64}}
|
||
|
|
responses:
|
||
|
|
'200': {description: 查询成功}
|
||
|
|
'403': {description: 无查看权限}
|
||
|
|
'404': {description: 任务不存在}
|
||
|
|
/api/platform/v1/first-leg/tasks/{taskId}/assignment-history:
|
||
|
|
get:
|
||
|
|
summary: 分页查询任务分配历史
|
||
|
|
description: 需要 platform:firstleg:assignment:history 权限
|
||
|
|
parameters:
|
||
|
|
- $ref: '#/components/parameters/TenantId'
|
||
|
|
- $ref: '#/components/parameters/TaskId'
|
||
|
|
- $ref: '#/components/parameters/Page'
|
||
|
|
- $ref: '#/components/parameters/Size'
|
||
|
|
responses:
|
||
|
|
'200': {description: 查询成功}
|
||
|
|
'403': {description: 无历史查看权限}
|
||
|
|
'404': {description: 任务不存在}
|
||
|
|
/api/platform/v1/first-leg/tasks/{taskId}/assignment:
|
||
|
|
post:
|
||
|
|
summary: 分配或改派履约任务
|
||
|
|
description: 需要 platform:firstleg:assignment:assign 权限
|
||
|
|
parameters:
|
||
|
|
- $ref: '#/components/parameters/TenantId'
|
||
|
|
- $ref: '#/components/parameters/TaskId'
|
||
|
|
requestBody:
|
||
|
|
required: true
|
||
|
|
content:
|
||
|
|
application/json:
|
||
|
|
schema: {$ref: '#/components/schemas/AssignRequest'}
|
||
|
|
responses:
|
||
|
|
'200': {description: 分配成功}
|
||
|
|
'403': {description: 无分配权限}
|
||
|
|
'404': {description: 任务不存在}
|
||
|
|
'409': {description: 任务已关闭或发生并发更新}
|
||
|
|
components:
|
||
|
|
securitySchemes:
|
||
|
|
bearerAuth:
|
||
|
|
type: http
|
||
|
|
scheme: bearer
|
||
|
|
bearerFormat: JWT
|
||
|
|
parameters:
|
||
|
|
TenantId:
|
||
|
|
name: tenantId
|
||
|
|
in: query
|
||
|
|
required: true
|
||
|
|
schema: {type: integer, format: int64, minimum: 1}
|
||
|
|
TaskId:
|
||
|
|
name: taskId
|
||
|
|
in: path
|
||
|
|
required: true
|
||
|
|
schema: {type: integer, format: int64}
|
||
|
|
Page:
|
||
|
|
name: page
|
||
|
|
in: query
|
||
|
|
schema: {type: integer, format: int64, minimum: 1, default: 1}
|
||
|
|
Size:
|
||
|
|
name: size
|
||
|
|
in: query
|
||
|
|
schema: {type: integer, format: int64, minimum: 1, maximum: 200, default: 20}
|
||
|
|
schemas:
|
||
|
|
AssignRequest:
|
||
|
|
type: object
|
||
|
|
required: [assigneeId, assigneeName]
|
||
|
|
properties:
|
||
|
|
assigneeId: {type: integer, format: int64}
|
||
|
|
assigneeName: {type: string, maxLength: 64}
|
||
|
|
reason: {type: string, maxLength: 500}
|