summaryrefslogtreecommitdiff
path: root/data/zh_cn/workorder/2020-12-10
diff options
context:
space:
mode:
Diffstat (limited to 'data/zh_cn/workorder/2020-12-10')
-rw-r--r--data/zh_cn/workorder/2020-12-10/api-docs.php847
1 files changed, 847 insertions, 0 deletions
diff --git a/data/zh_cn/workorder/2020-12-10/api-docs.php b/data/zh_cn/workorder/2020-12-10/api-docs.php
new file mode 100644
index 0000000..c89d201
--- /dev/null
+++ b/data/zh_cn/workorder/2020-12-10/api-docs.php
@@ -0,0 +1,847 @@
+<?php return [
+ 'version' => '1.0',
+ 'info' => [
+ 'style' => 'RPC',
+ 'product' => 'Workorder',
+ 'version' => '2020-12-10',
+ ],
+ 'directories' => [
+ [
+ 'id' => 0,
+ 'title' => '其它',
+ 'type' => 'directory',
+ 'children' => [
+ 'SuggestCategory',
+ 'GetTicketTemplate',
+ 'IsFirstBbsTicket',
+ ],
+ ],
+ ],
+ 'components' => [
+ 'schemas' => [
+ 'CategoryParam' => [
+ 'title' => 'CategoryParam',
+ 'description' => '问题分类参数',
+ 'type' => 'object',
+ 'properties' => [
+ 'CategoryId' => [
+ 'title' => '二级问题分类ID',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ ],
+ 'CategoryName' => [
+ 'title' => '二级问题分类名称',
+ 'type' => 'string',
+ ],
+ 'ProductId' => [
+ 'title' => '一级问题分类ID',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ ],
+ 'ProductName' => [
+ 'title' => '一级问题分类名称',
+ 'type' => 'string',
+ ],
+ 'IsSelectFromDialog' => [
+ 'title' => '是否来自对话',
+ 'type' => 'boolean',
+ ],
+ ],
+ ],
+ 'DialogBaseBody' => [
+ 'title' => 'A short description of struct',
+ 'description' => '对话基础对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'title' => '状态',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'DataInfo' => [
+ 'title' => '对话内容',
+ 'type' => 'object',
+ 'properties' => [
+ 'Schema' => [
+ 'title' => '卡片内容',
+ 'type' => 'string',
+ ],
+ 'Values' => [
+ 'title' => '卡片值',
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'any',
+ ],
+ ],
+ 'Title' => [
+ 'title' => '标题',
+ 'type' => 'string',
+ ],
+ 'BizType' => [
+ 'title' => '埋点',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'Props' => [
+ 'title' => '新版对话组件的属性',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'any',
+ ],
+ ],
+ ],
+ 'ContentDesensitized' => [
+ 'title' => '对话脱敏后内容',
+ 'type' => 'string',
+ ],
+ 'Container' => [
+ 'type' => 'any',
+ ],
+ 'Content' => [
+ 'title' => '对话内容',
+ 'type' => 'string',
+ ],
+ 'SchemaId' => [
+ 'title' => '卡片ID',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ ],
+ 'Editable' => [
+ 'title' => '是否可操作',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'Component' => [
+ 'title' => '新版对话组件',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'any',
+ ],
+ ],
+ ],
+ 'BizId' => [
+ 'title' => '埋点',
+ 'type' => 'string',
+ ],
+ 'ServiceChannel' => [
+ 'title' => '服务渠道',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'HitWords' => [
+ 'title' => '命中关键字',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'string',
+ ],
+ ],
+ 'CreateTime' => [
+ 'title' => '创建时间戳',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ ],
+ 'DialogId' => [
+ 'title' => '对话ID',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ ],
+ 'ChannelCode' => [
+ 'title' => '渠道code',
+ 'type' => 'string',
+ ],
+ 'UserInfo' => [
+ 'title' => '用户信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'Role' => [
+ 'title' => '身份角色',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'UserName' => [
+ 'title' => '用户名',
+ 'type' => 'string',
+ ],
+ 'UserId' => [
+ 'title' => '用户ID',
+ 'type' => 'string',
+ ],
+ 'Avatar' => [
+ 'title' => '头像',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'TicketStatus' => [
+ 'title' => '工单状态快照',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'Attachments' => [
+ 'title' => '消息附件',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => [
+ 'title' => '类型',
+ 'type' => 'string',
+ ],
+ 'Size' => [
+ 'title' => '大小',
+ 'type' => 'string',
+ ],
+ 'Url' => [
+ 'title' => '链接',
+ 'type' => 'string',
+ ],
+ 'Name' => [
+ 'title' => '名称',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ 'Timestamp' => [
+ 'title' => '时间戳',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ ],
+ 'ReferInfo' => [
+ 'title' => '引用对话',
+ '$ref' => '#/components/schemas/DialogBaseBody',
+ ],
+ 'FooterInfo' => [
+ 'title' => '对话脚',
+ 'type' => 'object',
+ 'properties' => [
+ 'Ext' => [
+ 'title' => '值',
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'any',
+ ],
+ ],
+ 'Schema' => [
+ 'title' => '卡片内容',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'Type' => [
+ 'title' => '类型',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'TicketId' => [
+ 'title' => '工单ID',
+ 'type' => 'string',
+ ],
+ 'ModifiedTime' => [
+ 'title' => '修改时间时间戳',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ ],
+ 'Stage' => [
+ 'title' => '处理阶段',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'Tip' => [
+ 'title' => '提示',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'WelcomeBlock' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => [
+ 'type' => 'string',
+ ],
+ 'DisplayType' => [
+ 'type' => 'string',
+ ],
+ 'Label' => [
+ 'type' => 'string',
+ ],
+ 'Value' => [
+ 'type' => 'string',
+ ],
+ 'Icon' => [
+ 'type' => 'string',
+ ],
+ 'Description' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'apis' => [
+ 'SuggestCategory' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TicketId',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ ],
+ ],
+ [
+ 'name' => 'Content',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'TopN',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ ],
+ [
+ 'name' => 'UseHotSuggestCatchAll',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'boolean',
+ ],
+ ],
+ [
+ 'name' => 'Cna',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'DistributionChannel',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'SubDistributionChannel',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'Referrer',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'XGatewayExtendInfo',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Success' => [
+ 'type' => 'boolean',
+ ],
+ 'Data' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ ],
+ ],
+ 'AccessDeniedDetail' => [
+ 'type' => 'string',
+ ],
+ 'HttpStatusCode' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'No permissions',
+ 'errorMessage' => 'No permissions to access.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '',
+ ],
+ 'GetTicketTemplate' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ [
+ 'APP' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'CategoryId',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '99999999',
+ 'minimum' => '0',
+ ],
+ ],
+ [
+ 'name' => 'Cna',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'DistributionChannel',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'SubDistributionChannel',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'Referrer',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'XGatewayExtendInfo',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'type' => 'object',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Success' => [
+ 'type' => 'boolean',
+ ],
+ 'Code' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'PageNumber' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'PageSize' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'TotalCount' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ ],
+ 'AccessDeniedDetail' => [
+ 'type' => 'string',
+ ],
+ 'HttpStatusCode' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ [
+ 'errorCode' => 'No permissions',
+ 'errorMessage' => 'No permissions to access.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '',
+ ],
+ 'IsFirstBbsTicket' => [
+ 'summary' => '是否首次访问BBS工单',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Cna',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'DistributionChannel',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'SubDistributionChannel',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'Referrer',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'XGatewayExtendInfo',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Success' => [
+ 'type' => 'boolean',
+ ],
+ 'Data' => [
+ 'type' => 'boolean',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '',
+ ],
+ ],
+ 'endpoints' => [
+ [
+ 'regionId' => 'ap-northeast-1',
+ 'endpoint' => 'workorder.ap-northeast-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-southeast-1',
+ 'endpoint' => 'workorder.ap-southeast-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-northeast-2-pop',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-south-1',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-southeast-2',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-southeast-3',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-southeast-5',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-beijing',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-beijing-finance-1',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-beijing-finance-pop',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-beijing-gov-1',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-beijing-nu16-b01',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-chengdu',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-edge-1',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-fujian',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-haidian-cm12-c01',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-hangzhou',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-hangzhou-bj-b01',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-hangzhou-finance',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-hangzhou-internal-prod-1',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-hangzhou-internal-test-1',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-hangzhou-internal-test-2',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-hangzhou-internal-test-3',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-hangzhou-test-306',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-hongkong',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-hongkong-finance-pop',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-huhehaote',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-north-2-gov-1',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-qingdao',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-qingdao-nebula',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shanghai',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shanghai-et15-b01',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shanghai-et2-b01',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shanghai-finance-1',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shanghai-inner',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shanghai-internal-test-1',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shenzhen',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shenzhen-finance-1',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shenzhen-inner',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shenzhen-st4-d01',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shenzhen-su18-b01',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-wuhan',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-yushanfang',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-zhangbei-na61-b01',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-zhangjiakou',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-zhangjiakou-na62-a01',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-zhengzhou-nebula-1',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'eu-central-1',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'eu-west-1',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'eu-west-1-oxs',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'me-east-1',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'rus-west-1-pop',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'us-east-1',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'us-west-1',
+ 'endpoint' => 'workorder.aliyuncs.com',
+ ],
+ ],
+];