数据模型

model naming

常用业务模型

模型的使用

参数包装，新建、更新数据时一般需要把需要保存的数据包装在相应的model名称里面

如API传参JSON数据:

{
  //...
  customer: {name: "wangdaye"},
  //...
}

如果需要更新一些关联数据一般有如下更新方式

一个客户拥有一个地址信息

# json 数据
customer: {address_attributes: {id: 1, note: "whosyourdaddy"}}
# form encode
customer[address_attributes][id]=1
customer[address_attributes][note]='whosyourdaddy'

一个客户拥有多个联系人信息

# json 数据
customer: {contacts_attributes: {id: 1, name: "nierye"}}
# form encode
customer[contacts_attributes][id]=1
customer[contacts_attributes][name]='nierye'

在更新操作的时候都推荐传入 关联记录的 id

作为 url Parameter 的传入值

/api/openapi/v2/custom_fields/:entity_type/by_group
/api/openapi/v2/custom_fields/Custoemr/by_group

这里的 Customer 作为 entity_type 的值

/api/openapi/v2/attachments/:entity/:id/upload_attachments

/api/openapi/v2/attachments/Customer/2/upload_attachments

这里的 Customer 作为 entity 的值, 2 作为 id; 整个地址表示更新 id 为 2 的 customer 的附件

在多态 model 中被使用

系统中使用到的多态

所有使用多态的model 在提交参数或者服务端 响应的时候, 均会派生出两个参数 ${#{field_name}_id} 和 ${#{field_name}_type}

如果 字段名叫 addressable 则会有 ${addressable_id} 和 ${addressable_type}

例如 提交表单中

# json 数据
revisit_log: {loggable_id: 2, loggable_type: "Customer"}
# form encode
revisit_log[loggable_id]=2&revisit_log[loggable_type]=Customer

例如 返回数据中

revisit_log: loggable: {name: "wangdaye"}, loggable_id: 2, loggable_type: "Customer"

使用多态的具体模块

• At

At

atable

RevisitLog
SalesCircle

• Like

Like

likeable

SalesCircle

Address模型(地址信息)

Announcement模型(系统公告)

Attachment模型(文件附件)

Contact模型(联系人)

ContactAssetship模型(联系人)

Contract模型(合同)

CustomField模型(自定义字段)

CustomReport模型(自定义报表)

Customer模型(客户)

CustomerCommon模型(公海客户)

DataReport模型(数据上报模板)

DataReportArea模型(地区节点)

DataReportStore模型(公司)

Department模型(部门)

Event模型(日程)

Faq模型(常见问题)

FaqCategory模型(常见问题)

FieldValue模型(数据字典参数)

InvoicedPayment模型(开票)

KnowledgeEntity模型(知识库文件)

KnowledgeSection模型(版块)

Lead模型(线索)

LoginLog模型(登录日志)

ManualCategory模型(操作类别)

Marking模型(点评)

Notification模型(通知)

OperationLog模型(操作日志)

Opportunity模型(商机)

Organization模型(公司)

Product模型(产品)

ProductAsset模型(关联产品)

ReceivedPayment模型(回款)

ReceivedPaymentPlan模型(回款计划)

RevisitLog模型(跟进记录)

Role模型(角色)

SalesGoalYearly模型(业绩目标)