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
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="apigee_v1.html">Apigee API</a> . <a href="apigee_v1.organizations.html">organizations</a> . <a href="apigee_v1.organizations.sites.html">sites</a> . <a href="apigee_v1.organizations.sites.apicategories.html">apicategories</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new API category.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an API category.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets an API category.</p>
<p class="toc_element">
<code><a href="#list">list(parent, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the API categories associated with a portal.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an API category.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates a new API category.
Args:
parent: string, Required. Name of the portal. Use the following structure in your request: `organizations/{org}/sites/{site}` (required)
body: object, The request body.
The object takes the form of:
{ # `ApiCategory` represents an API category. [Catalog items](/apigee/docs/reference/apis/apigee/rest/v1/organizations.sites.apidocs) can be tagged with API categories; users viewing the API catalog in the portal will have the option to browse the catalog by category.
"id": "A String", # ID of the category (a UUID).
"name": "A String", # Name of the category.
"siteId": "A String", # Name of the portal.
"updateTime": "A String", # Time the category was last modified in milliseconds since epoch.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The API category resource wrapped with response status, error_code, etc.
"data": { # `ApiCategory` represents an API category. [Catalog items](/apigee/docs/reference/apis/apigee/rest/v1/organizations.sites.apidocs) can be tagged with API categories; users viewing the API catalog in the portal will have the option to browse the catalog by category. # The API category resource.
"id": "A String", # ID of the category (a UUID).
"name": "A String", # Name of the category.
"siteId": "A String", # Name of the portal.
"updateTime": "A String", # Time the category was last modified in milliseconds since epoch.
},
"errorCode": "A String", # Unique error code for the request, if any.
"message": "A String", # Description of the operation.
"requestId": "A String", # Unique ID of the request.
"status": "A String", # Status of the operation.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes an API category.
Args:
name: string, Required. Name of the category. Use the following structure in your request: `organizations/{org}/sites/{site}/apicategories/{apicategory}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for certain delete operations.
"errorCode": "A String", # Unique error code for the request, if any.
"gcpResource": "A String", # Google Cloud name of deleted resource.
"message": "A String", # Description of the operation.
"requestId": "A String", # Unique ID of the request.
"status": "A String", # Status of the operation.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets an API category.
Args:
name: string, Required. Name of the category. Use the following structure in your request: `organizations/{org}/sites/{site}/apicategories/{apicategory}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The API category resource wrapped with response status, error_code, etc.
"data": { # `ApiCategory` represents an API category. [Catalog items](/apigee/docs/reference/apis/apigee/rest/v1/organizations.sites.apidocs) can be tagged with API categories; users viewing the API catalog in the portal will have the option to browse the catalog by category. # The API category resource.
"id": "A String", # ID of the category (a UUID).
"name": "A String", # Name of the category.
"siteId": "A String", # Name of the portal.
"updateTime": "A String", # Time the category was last modified in milliseconds since epoch.
},
"errorCode": "A String", # Unique error code for the request, if any.
"message": "A String", # Description of the operation.
"requestId": "A String", # Unique ID of the request.
"status": "A String", # Status of the operation.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, x__xgafv=None)</code>
<pre>Returns the API categories associated with a portal.
Args:
parent: string, Required. Name of the portal. Use the following structure in your request: `organizations/{org}/sites/{site}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response for `ListApiCategoriesRequest`. Next ID: 6
"data": [ # The API category resources.
{ # `ApiCategory` represents an API category. [Catalog items](/apigee/docs/reference/apis/apigee/rest/v1/organizations.sites.apidocs) can be tagged with API categories; users viewing the API catalog in the portal will have the option to browse the catalog by category.
"id": "A String", # ID of the category (a UUID).
"name": "A String", # Name of the category.
"siteId": "A String", # Name of the portal.
"updateTime": "A String", # Time the category was last modified in milliseconds since epoch.
},
],
"errorCode": "A String", # Unique error code for the request, if any.
"message": "A String", # Description of the operation.
"requestId": "A String", # Unique ID of the request.
"status": "A String", # Status of the operation.
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code>
<pre>Updates an API category.
Args:
name: string, Required. Name of the category. Use the following structure in your request: `organizations/{org}/sites/{site}/apicategories/{apicategory}` (required)
body: object, The request body.
The object takes the form of:
{ # `ApiCategory` represents an API category. [Catalog items](/apigee/docs/reference/apis/apigee/rest/v1/organizations.sites.apidocs) can be tagged with API categories; users viewing the API catalog in the portal will have the option to browse the catalog by category.
"id": "A String", # ID of the category (a UUID).
"name": "A String", # Name of the category.
"siteId": "A String", # Name of the portal.
"updateTime": "A String", # Time the category was last modified in milliseconds since epoch.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The API category resource wrapped with response status, error_code, etc.
"data": { # `ApiCategory` represents an API category. [Catalog items](/apigee/docs/reference/apis/apigee/rest/v1/organizations.sites.apidocs) can be tagged with API categories; users viewing the API catalog in the portal will have the option to browse the catalog by category. # The API category resource.
"id": "A String", # ID of the category (a UUID).
"name": "A String", # Name of the category.
"siteId": "A String", # Name of the portal.
"updateTime": "A String", # Time the category was last modified in milliseconds since epoch.
},
"errorCode": "A String", # Unique error code for the request, if any.
"message": "A String", # Description of the operation.
"requestId": "A String", # Unique ID of the request.
"status": "A String", # Status of the operation.
}</pre>
</div>
</body></html>
|
