自定义对象手册
Zend亚博esk API允许您使用本机对象，例如票而且用户．虽然你有很多东西可以支配，但现有的东西并不能满足每个客户的所有可能的需求。输入自定义对象。
自定义对象API允许您在Zendesk中定义一个新的对象类型，然后根据新的对象类型创建对象。亚博该API将对象存储在Zendesk基础设施中。亚博您还可以使用它来定义和管理与其他对象的关系，包括门票和用户等原生Zendesk对象。亚博
该API由以下资源组成:亚博电脑端
对象类型
一个对象类型是该类型对象的模板。它由一个关键属性和模式属性。
的关键是标识对象类型的名称，就像Zendesk API中的“ticket”或“user”。亚博
的模式描述数据。模式不包含关于特定对象的任何信息。它只是描述了这个信息。您还可以在模式中定义验证规则，以维护对象记录的数据完整性。有关更多信息，请参见为自定义对象创建模式．
例子:
｛“数据”：｛“关键”：“复印机”，“模式”：｛“属性”：｛“id”：｛“类型”：“字符串”，“描述”："由IT部门分配给复印机的唯一标识符"｝，“模型”：｛“类型”：“字符串”，“描述”：“复印机的型号和型号”｝，“网络”：｛“类型”：“布尔”，“描述”："复印机是否联网"｝｝，“要求”：［“id”，“模型”］｝｝｝
API的路径
对象类型的API路径为/ api /阳光/对象/类型．详情请参阅API文档。
API文档
看到对象类型在API文档中。
对象记录
一个对象记录是给定对象类型的实例。它由一个类型字符串和属性对象。类型是任意的名称(或键)对象类型你定义的。的属性对象包含为对象类型定义的属性及其值。
例子:
｛“数据”：｛“类型”：“复印机”，“属性”：｛“id”："1019 4c bw "，“模型”：“OptiJet X55”，“网络”：真正的｝｝｝
API的路径
对象记录的API路径为/ api /阳光/对象/记录．详情请参阅API文档。
API文档
看到对象记录在API文档中。
关系类型
您可以定义对象之间的关系，以更有意义的方式使用数据。关系可以是:
- 两个自定义对象
- 一个自定义对象和以下任何本地Zendesk对象:门票、用户、文章、组织、组或聊天。亚博
- 列出的两个原生Zendesk对象亚博
API支持三种关系类型:
一对一的-两种对象类型在关系的任何一方都只能有一个对象。例如，一张票只能与唯一的复印机相关联，而一台复印机只能与唯一的票相关联。在IT部门的例子中，这不是一个可行的选择。复印机对象的数量必须等于票据对象的数量。
一对多或多对一—在一对多关系类型中，第一个对象类型中的每个对象都不关联、第二个对象类型中的一个或多个对象。例如，复印机可以与一张票、一张票或多张票关联。在多对一关系类型中，第一种对象类型的任何对象、一个对象或多个对象都可以与第二种对象类型的每个对象相关联。例如，一张票、一张票或多张票可以与一台复印机相关联。对于相同的数据，这种不同的视角会对您访问数据的方式产生影响。
多对多—使用两个一对多关系类型定义多对多关系类型。第一种对象类型的每个对象都不与第二种对象类型的任何一个或多个对象相关，第二种对象类型的每个对象都不与第一种对象类型的任何一个或多个对象相关。
一个关系类型由以下属性组成:关键，源,目标．键是标识关系类型的名称。源是一对一或一对多关系类型中的左侧“1”，或多对一关系类型中的左侧“许多”。目标是右边的“一”或“许多”。它们的值可以是您定义的任何对象类型的名称，也可以是本机Zendesk对象类型的以下任何名称:亚博
- 战:机票
- 禅宗:用户
- 战:文章
- 战:组织
- 战:组
- 战:聊天
- 战:品牌
- 战:铅
- 战:联系
- 战:协议
源和目标可以是两个自定义对象类型，一个自定义对象类型和一个Zendesk对象类型，或者两个Zendesk对象类型，作为源或目标。亚博
要定义一对多关系类型，请将目标值括在方括号中。若要定义多对一关系类型，请将源值括在方括号中。对于一对一关系类型，省略方括号。
定义关系类型并不会在两个特定对象之间创建关联。它只是描述了关系记录。要关联两个对象，必须创建关系的记录在两个物体之间。看到关系的记录．
例子:
｛“数据”：｛“关键”：“copier_has_many_tickets”，“源”：“复印机”，“目标”：［“战:票”］｝｝
API的路径
关系类型的API路径为/ / api /阳光/关系类型．详情请参阅API文档。
API文档
看到关系类型在API文档中。
关系的记录
一个关系的记录给定关系类型的实例。它将两个特定的对象记录绑定在一起。关系记录由两个相关对象记录的id和关系类型组成。该记录不包含任何实际的对象数据——只包含对象记录的id。
创建关系记录允许您使用按对象记录列出关系记录端点获取到与特定对象关联的所有对象记录的链接。例如，单个请求可以返回到与特定复印机相关的所有票据的链接。
例子:
｛“数据”：｛“relationship_type”：“copier_has_many_tickets”，“源”：“1 c771ee0-2c3f-11e7-bf60-e5c3f630b5aa”，“目标”：“35437746”｝｝
API的路径
关系记录的API路径为/ / api /阳光/关系记录．详情请参阅API文档。
API文档
看到关系的记录在API文档中。
工作
您可以使用Jobs API来定义和运行您自己的批处理作业对象记录而且关系的记录．例如，您可以定义并运行一个在Zendesk中创建许多对象记录的作业。亚博
批处理作业是异步的。发出请求会启动作业，但API在发送响应之前不会等待作业完成。响应为您提供了一个作业id，您可以使用它轮询API以获得作业的状态。作业可以是“排队”、“处理中”、“失败”、“完成”或“中止”。
你只用一个端点，创建工作，用于所有批处理操作:
发布api / custom_r亚博电脑端esources /工作
端点接受一个JSON对象，具有以下属性:
| 的名字 | 类型 | 评论 |
|---|---|---|
| 类型 | 字符串 | “资源”或“关系亚博电脑端”之一 |
| 行动 | 字符串 | 目前只支持post |
| 数据 | 数组 | 要处理的对象记录或关系记录的数组。对象记录或关系记录的等效单操作端点的格式与“data”对象相同 |
例子:
｛“类型”：“亚博电脑端资源”，“行动”：“职位”，“数据”：［｛“类型”：“产品”，“external_id”：“3”，“属性”：｛“id”：“3”，“名称”：“草莓口香糖”｝｝，｛“类型”：“产品”，“external_id”：“4”，“属性”：｛“id”：“4”，“名称”：“咖啡口香糖”｝｝］｝
API的路径
作业的API路径是/ api / cust亚博电脑端om_resources /工作．详情请参阅API文档。
API文档
看到工作在API文档中。