summaryrefslogtreecommitdiff
path: root/data/en_us/workorder/2020-12-10/api-docs.php
blob: e6b5b7341d73a3b7d3a2ae0461509ad3d56687cb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
<?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' => [],
    ],
    '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' => null,
        ],
        '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' => null,
        ],
        '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' => null,
        ],
    ],
    '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'],
    ],
];