作者 陈志颖

docs:更新接口文档

正在显示 100 个修改的文件 包含 0 行增加928 行删除

要显示太多修改。

为保证性能只显示 100 of 100+ 个文件。

不能预览此文件类型
不能预览此文件类型
version: v1
kind: HttpApi
metadata:
service: contractUndertakerFeedback
path: /contract-undertaker-feedbacks
endpoints:
- method: createContractUndertakerFeedback
route:
post: /
- method: updateContractUndertakerFeedback
route:
put: /{contractUndertakerFeedbackId}
- method: getContractUndertakerFeedback
route:
get: /{contractUndertakerFeedbackId}
- method: removeContractUndertakerFeedback
route:
delete: /{contractUndertakerFeedbackId}
- method: searchContractUndertakerFeedback
route:
post: /search
- method: listContractUndertakerFeedback
route:
get: /
params:
- name: offset
- name: limit
version: v1
kind: HttpApi
metadata:
service: cooperationApplication
path: /cooperation-applications
endpoints:
- method: applyForCooperation
route:
post: /apply-for-cooperation
- method: agreeCooperationApplication
route:
post: /agree-cooperation-application
- method: rejectCooperationApplication
route:
post: /reject-cooperation-application
- method: createCooperationApplication
route:
post: /
- method: updateCooperationApplication
route:
put: /{cooperationApplicationId}
- method: getCooperationApplication
route:
get: /{cooperationApplicationId}
- method: removeCooperationApplication
route:
delete: /{cooperationApplicationId}
- method: searchCooperationApplication
route:
post: /search
- method: listCooperationApplication
route:
get: /
params:
- name: offset
- name: limit
version: v1
kind: HttpApi
metadata:
service: cooperationContractChangeLog
path: /cooperation-contract-change-logs
endpoints:
- method: createCooperationContractChangeLog
route:
post: /
- method: updateCooperationContractChangeLog
route:
put: /{cooperationContractChangeLogId}
- method: getCooperationContractChangeLog
route:
get: /{cooperationContractChangeLogId}
- method: removeCooperationContractChangeLog
route:
delete: /{cooperationContractChangeLogId}
- method: listCooperationContractChangeLog
route:
get: /
params:
- name: offset
- name: limit
- method: searchCooperationContractChangeLog
route:
post: /search
version: v1
kind: HttpApi
metadata:
service: cooperationContract
path: /cooperation-contracts
endpoints:
- method: createCooperationContract
route:
post: /
- method: updateCooperationContract
route:
put: /{cooperationContractId}
- method: getCooperationContract
route:
get: /{cooperationContractId}
- method: removeCooperationContract
route:
delete: /{cooperationContractId}
- method: searchCooperationContract
route:
post: /search
- method: searchCooperationContractByUndertaker
route:
post: /search-by-undertaker
- method: listCooperationContract
route:
get: /
params:
- name: offset
- name: limit
version: v1
kind: HttpApi
metadata:
service: cooperationMode
path: /cooperation-modes
endpoints:
- method: createCooperationMode
route:
post: /
- method: updateCooperationMode
route:
put: /{cooperationModeId}
- method: getCooperationMode
route:
get: /{cooperationModeId}
- method: removeCooperationMode
route:
delete: /{cooperationModeId}
- method: searchCooperationMode
route:
post: /search
- method: listCooperationMode
route:
get: /
params:
- name: offset
- name: limit
version: v1
kind: HttpApi
metadata:
service: cooperationProject
path: /cooperation-projects
endpoints:
- method: releaseCooperationProject
route:
post: /release-cooperation-project
- method: createCooperationProject
route:
post: /
- method: updateCooperationProject
route:
put: /{cooperationProjectId}
- method: getCooperationProject
route:
get: /{cooperationProjectId}
- method: removeCooperationProject
route:
delete: /{cooperationProjectId}
- method: searchCooperationProject
route:
post: /search
- method: listCooperationProject
route:
get: /
params:
- name: offset
- name: limit
version: v1
kind: HttpApi
metadata:
service: creditAccount
path: /credit-accounts
endpoints:
- method: createCreditAccount
route:
post: /
- method: updateCreditAccount
route:
put: /{creditAccountId}
- method: getCreditAccount
route:
get: /{creditAccountId}
- method: removeCreditAccount
route:
delete: /{creditAccountId}
- method: searchCreditAccount
route:
post: /search
- method: payCreditAccount
route:
post: /pay
- method: listCreditAccount
route:
get: /
params:
- name: offset
- name: limit
version: v1
kind: HttpApi
metadata:
service: dividendsEstimate
path: /dividends-estimates
endpoints:
- method: createDividendsEstimate
route:
post: /
- method: updateDividendsEstimate
route:
put: /{dividendsEstimateId}
- method: getDividendsEstimate
route:
get: /{dividendsEstimateId}
- method: removeDividendsEstimate
route:
delete: /{dividendsEstimateId}
- method: cancelDividendsEstimate
route:
post: /{dividendsEstimateId}/cancel
- method: searchDividendsEstimate
route:
post: /search
- method: estimateDividendsIncentives
route:
post: /estimate-dividends-incentives
- method: estimateMoneyIncentives
route:
post: /estimate-money-incentives
- method: listMoneyIncentives
route:
get: /list-money-incentives
- method: searchMoneyIncentives
route:
post: /search-money-incentives
- method: listDividendsIncentives
route:
get: /list-dividends-incentives
- method: searchDividendsIncentives
route:
post: /search-dividends-incentives
- method: listDividendsEstimate
route:
get: /
params:
- name: offset
- name: limit
version: v1
kind: HttpApi
metadata:
service: dividendsOrder
path: /dividends-orders
endpoints:
- method: createDividendsOrder
route:
post: /
- method: updateDividendsOrder
route:
put: /{dividendsOrderId}
- method: getDividendsOrder
route:
get: /{dividendsOrderId}
- method: removeDividendsOrder
route:
delete: /{dividendsOrderId}
- method: searchDividendsOrder
route:
post: /search
- method: listDividendsOrder
route:
get: /
params:
- name: offset
- name: limit
version: v1
kind: HttpApi
metadata:
service: dividendsReturnedOrder
path: /dividends-returned-orders
endpoints:
- method: createDividendsReturnedOrder
route:
post: /
- method: updateDividendsReturnedOrder
route:
put: /{dividendsReturnedOrderId}
- method: getDividendsReturnedOrder
route:
get: /{dividendsReturnedOrderId}
- method: removeDividendsReturnedOrder
route:
delete: /{dividendsReturnedOrderId}
- method: searchDividendsReturnedOrder
route:
post: /search
- method: importDividendsReturnedOrder
route:
post: /import
- method: listDividendsReturnedOrder
route:
get: /
params:
- name: offset
- name: limit
version: v1
kind: Attribute
metadata:
name: fileSize
description: 附件文件大小
type:
primitive: int64
version: v1
kind: Attribute
metadata:
name: fileType
description: 附件文件类型,jpg,pdf
type:
primitive: string
version: v1
kind: Attribute
metadata:
name: name
description: 附件名称
type:
primitive: string
version: v1
kind: Attribute
metadata:
name: url
description: 附件地址
type:
primitive: string
version: v1
kind: Attribute
metadata:
name: count
description: 匹配数目
type:
primitive: int64
version: v1
kind: Attribute
metadata:
name: createdAt
description: 创建时间
type:
primitive: datetime
version: v1
kind: Attribute
metadata:
name: deletedAt
description: 删除时间
type:
primitive: datetime
version: v1
kind: Attribute
metadata:
name: limit
description: 查询限制
type:
primitive: int
version: v1
kind: Attribute
metadata:
name: offset
description: 查询偏离量
type:
primitive: int
version: v1
kind: Attribute
metadata:
name: operateTime
description: 操作时间
type:
primitive: datetime
version: v1
kind: Attribute
metadata:
name: operator
description: 操作人
type:
schema: user
version: v1
kind: Attribute
metadata:
name: pageNumber
description: 页面大小
type:
primitive: int32
version: v1
kind: Attribute
metadata:
name: pageSize
description: 页面大小
type:
primitive: int32
version: v1
kind: Attribute
metadata:
name: remarks
description: 备注
type:
primitive: string
version: v1
kind: Attribute
metadata:
name: status
description: 状态
type:
primitive: int32
version: v1
kind: Attribute
metadata:
name: updatedAt
description: 更新时间
type:
primitive: datetime
version: v1
kind: Attribute
metadata:
name: userInfo
description: 冗余字段,jsonb格式,不限制存放内容
type:
schema: userInfo
version: v1
kind: Attribute
metadata:
name: companyId
description: 公司ID,通过集成REST上下文获取
type:
primitive: int64
version: v1
kind: Attribute
metadata:
name: companyLogo
description: 公司logo
type:
primitive: string
version: v1
kind: Attribute
metadata:
name: companyName
description: 公司名称
type:
primitive: string
version: v1
kind: Attribute
metadata:
name: contractUndertaker
description: 共创合约承接人
type:
schema: user
version: v1
kind: Attribute
metadata:
name: feedbackAttachment
description: 合约承接方反馈内容附件
type:
array: attachment
version: v1
kind: Attribute
metadata:
name: feedbackContent
description: 合约承接方反馈内容
type:
primitive: string
version: v1
kind: Attribute
metadata:
name: feedbackId
description: 合约承接方反馈记录ID
type:
primitive: int64
version: v1
kind: Attribute
metadata:
name: cooperationApplicationApplicant
description: 共创申请人
type:
schema: user
version: v1
kind: Attribute
metadata:
name: cooperationApplicationAttachment
description: 共创申请描述附件
type:
array: attachment
version: v1
kind: Attribute
metadata:
name: cooperationApplicationDescription
description: 共创申请描述
type:
primitive: string
version: v1
kind: Attribute
metadata:
name: cooperationApplicationId
description: 共创申请ID
type:
primitive: int64
version: v1
kind: Attribute
metadata:
name: cooperationApplicationStatus
description: 共创申请审核状态,1待审核,2已同意,3已拒绝
type:
primitive: int32
version: v1
kind: Attribute
metadata:
name: cooperationApplicationVerifier
description: 共创申请审核人
type:
schema: user
version: v1
kind: Attribute
metadata:
name: cooperationApplicationVerifyDescription
description: 共创申请审核描述
type:
primitive: string
version: v1
kind: Attribute
metadata:
name: cooperationApplicationVerifyTime
description: 共创申请审核时间
type:
primitive: datetime
version: v1
kind: Attribute
metadata:
name: cooperationApplyTime
description: 共创申请时间
type:
primitive: datetime
version: v1
kind: Attribute
metadata:
name: cooperationContractDescription
description: 共创合约描述
type:
primitive: string
version: v1
kind: Attribute
metadata:
name: cooperationContractDividendsIncentivesRules
description: 共创合约激励规则列表
type:
array: string
version: v1
kind: Attribute
metadata:
name: cooperationContractId
description: 共创合约ID
type:
primitive: int64
version: v1
kind: Attribute
metadata:
name: cooperationContractMoneyIncentivesRules
description: 共创合约金额激励规则列表
type:
array: string
version: v1
kind: Attribute
metadata:
name: cooperationContractName
description: 共创合约名称
type:
primitive: string
version: v1
kind: Attribute
metadata:
name: cooperationContractNumber
description: 共创合约编号
type:
primitive: string
version: v1
kind: Attribute
metadata:
name: cooperationContractReferrer
description: 合约推荐人
type:
schema: user
version: v1
kind: Attribute
metadata:
name: cooperationContractRelevants
description: 共创合约相关人
type:
array: user
version: v1
kind: Attribute
metadata:
name: cooperationContractSalesman
description: 共创合约业务员
type:
schema: user
version: v1
kind: Attribute
metadata:
name: cooperationContractSponsor
description: 共创合约发起人
type:
schema: user
version: v1
kind: Attribute
metadata:
name: cooperationContractUndertakerType
description: 共创合约承接对象,1员工,2共创用户,3公开
type:
array: int32
version: v1
kind: Attribute
metadata:
name: cooperationContractUndertakers
description: 共创合约承接人列表
type:
array: undertaker
version: v1
kind: Attribute
metadata:
name: cooperationMode
description: 共创模式
type:
schema: cooperationMode
version: v1
kind: Attribute
metadata:
name: cooperationContractChangeLogId
description: 合约变更记录ID
type:
primitive: int64
version: v1
kind: Attribute
metadata:
name: incentivesRule
description: 激励规则
type:
primitive: string
version: v1
kind: Attribute
metadata:
name: incentivesRuleDetail
description: 激励规则明细
type:
primitive: string
version: v1
kind: Attribute
metadata:
name: operationType
description: 合约变更操作类型,1编辑、2暂停、3恢复
type:
primitive: int32
version: v1
kind: Attribute
metadata:
name: undertakers
description: 承接人
type:
primitive: string
version: v1
kind: Attribute
metadata:
name: cooperationModeId
description: 共创模式ID
type:
primitive: int64
version: v1
kind: Attribute
metadata:
name: cooperationModeName
description: 共创模式名称
type:
primitive: string
version: v1
kind: Attribute
metadata:
name: cooperationModeNumber
description: 共创模式编码,手动输入,唯一确定
type:
primitive: string
version: v1
kind: Attribute
metadata:
name: cooperationProjectDescription
description: 共创项目描述
type:
primitive: string
version: v1
kind: Attribute
metadata:
name: cooperationProjectId
description: 共创项目ID
type:
primitive: int64
version: v1
kind: Attribute
metadata:
name: cooperationProjectName
description: 共创项目名称
type:
primitive: string
version: v1
kind: Attribute
metadata:
name: cooperationProjectNumber
description: 共创项目编号,自生成,生成规则:XM+6位年月日+#+3位流水,例XM210601#001
type:
primitive: string
version: v1
kind: Attribute
metadata:
name: cooperationProjectPublishTime
description: 共创项目发布时间
type:
primitive: datetime
version: v1
kind: Attribute
metadata:
name: cooperationProjectPublisher
description: 共创项目发布人
type:
schema: user
version: v1
kind: Attribute
metadata:
name: cooperationProjectSponsor
description: 共创项目发起人
type:
schema: user
version: v1
kind: Attribute
metadata:
name: cooperationProjectUndertakerType
description: 共创项目承接对象,1员工,2共创用户,3公开,可以多选
type:
array: int32
version: v1
kind: Attribute
metadata:
name: actuallyPaidAmount
description: 账期结算实付金额
type:
primitive: float64
version: v1
kind: Attribute
metadata:
name: creditAccountId
description: 账期结算单ID
type:
primitive: int64
version: v1
kind: Attribute
metadata:
name: creditAccountOrderNum
description: 账期结算单号
type:
primitive: string
version: v1
kind: Attribute
metadata:
name: paymentDocumentAttachment
description: 支付凭证附件
type:
schema: attachment
version: v1
kind: Attribute
metadata:
name: paymentStatus
description: 共创账期结算支付状态,1待支付,2已支付
type:
primitive: int32
version: v1
kind: Attribute
metadata:
name: paymentTime
description: 共创账期结算支付时间
type:
primitive: datetime
version: v1
kind: Attribute
metadata:
name: settlementAmount
description: 账期结算金额
type:
primitive: float64
version: v1
kind: Attribute
metadata:
name: settlementTime
description: 共创账期结算时间
type:
primitive: datetime
version: v1
kind: Attribute
metadata:
name: departmentId
description: 部门ID,通过REST集成上下文获取
type:
primitive: int64
version: v1
kind: Attribute
metadata:
name: departmentName
description: 部门名称
type:
primitive: string
version: v1
kind: Attribute
metadata:
name: departmentNumber
description: 部门编码
type:
primitive: string
version: v1
kind: Attribute
metadata:
name: isOrganization
description: 是否组织机构标识,1为是,2为否,默认为否
type:
primitive: boolean
version: v1
kind: Attribute
metadata:
name: dividendsAccountStatus
description: 分红结算状态,1待结算,2已结算
type:
primitive: int32
version: v1
kind: Attribute
metadata:
name: dividendsAmount
description: 分红金额
type:
primitive: float64
version: v1
kind: Attribute
metadata:
name: dividendsEstimateId
description: 承接人分红预算记录ID
type:
primitive: int64
version: v1
kind: Attribute
metadata:
name: dividendsEstimateOrderNumber
description: 承接人分红预算单号
type:
primitive: string
version: v1
kind: Attribute
metadata:
name: dividendsEstimateTime
description: 分红预算时间
type:
primitive: datetime
version: v1
kind: Attribute
metadata:
name: dividendsParticipateType
description: 参与分红类型,1承接人,2推荐人,3关联业务员
type:
primitive: int32
version: v1
kind: Attribute
metadata:
name: dividendsType
description: 分红类型,1订单分红,2退货冲销,3金额激励
type:
primitive: int32
version: v1
kind: Attribute
metadata:
name: dividendsUser
description: 分红用户
type:
schema: user
version: v1
kind: Attribute
metadata:
name: orderOrReturnedOrderNum
description: 分红订单号或退货单号
type:
primitive: string
version: v1
kind: Attribute
metadata:
name: dividendsIncentivesAmount
description: 业绩激励分红金额
type:
primitive: float64
version: v1
kind: Attribute
metadata:
name: dividendsIncentivesPercentage
description: 分红规则激励百分点
type:
primitive: float64
version: v1
kind: Attribute
metadata:
name: dividendsIncentivesRuleId
description: 分红规则ID
type:
primitive: int64
version: v1
kind: Attribute
metadata:
name: dividendsIncentivesStage
description: 分红规则激励阶段,阶段返回时需要转换为中文数字
type:
primitive: int64
version: v1
kind: Attribute
metadata:
name: dividendsIncentivesStageEnd
description: 分红规则激励阶段结束
type:
primitive: datetime