1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<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> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates a new category on the portal.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes a category from the portal.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Gets a category on the portal.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(parent, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists the categories on the portal.</p> 92<p class="toc_element"> 93 <code><a href="#patch">patch(name, body=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Updates a category on the portal.</p> 95<h3>Method Details</h3> 96<div class="method"> 97 <code class="details" id="close">close()</code> 98 <pre>Close httplib2 connections.</pre> 99</div> 100 101<div class="method"> 102 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 103 <pre>Creates a new category on the portal. 104 105Args: 106 parent: string, Required. Name of the portal. Use the following structure in your request: `organizations/{org}/sites/{site}` (required) 107 body: object, The request body. 108 The object takes the form of: 109 110{ # the Api category resource. 111 "id": "A String", # ID of the category (a UUID). 112 "name": "A String", # Name of the category. 113 "siteId": "A String", # Name of the portal. 114 "updateTime": "A String", # Time the category was last modified in milliseconds since epoch. 115} 116 117 x__xgafv: string, V1 error format. 118 Allowed values 119 1 - v1 error format 120 2 - v2 error format 121 122Returns: 123 An object of the form: 124 125 { # the Api category resource wrapped with response status, error_code etc. 126 "data": { # the Api category resource. # Details of category. 127 "id": "A String", # ID of the category (a UUID). 128 "name": "A String", # Name of the category. 129 "siteId": "A String", # Name of the portal. 130 "updateTime": "A String", # Time the category was last modified in milliseconds since epoch. 131 }, 132 "errorCode": "A String", # ID that can be used to find errors in the log files. 133 "message": "A String", # Description of the operation. 134 "requestId": "A String", # ID that can be used to find request details in the log files. 135 "status": "A String", # Status of the operation. 136}</pre> 137</div> 138 139<div class="method"> 140 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 141 <pre>Deletes a category from the portal. 142 143Args: 144 name: string, Required. Name of the category. Use the following structure in your request: `organizations/{org}/sites/{site}/apicategories/{apicategory}` (required) 145 x__xgafv: string, V1 error format. 146 Allowed values 147 1 - v1 error format 148 2 - v2 error format 149 150Returns: 151 An object of the form: 152 153 { 154 "errorCode": "A String", # ID that can be used to find errors in the log files. 155 "message": "A String", # Description of the operation. 156 "requestId": "A String", # ID that can be used to find request details in the log files. 157 "status": "A String", # Status of the operation. 158}</pre> 159</div> 160 161<div class="method"> 162 <code class="details" id="get">get(name, x__xgafv=None)</code> 163 <pre>Gets a category on the portal. 164 165Args: 166 name: string, Required. Name of the category. Use the following structure in your request: `organizations/{org}/sites/{site}/apicategories/{apicategory}` (required) 167 x__xgafv: string, V1 error format. 168 Allowed values 169 1 - v1 error format 170 2 - v2 error format 171 172Returns: 173 An object of the form: 174 175 { # the Api category resource wrapped with response status, error_code etc. 176 "data": { # the Api category resource. # Details of category. 177 "id": "A String", # ID of the category (a UUID). 178 "name": "A String", # Name of the category. 179 "siteId": "A String", # Name of the portal. 180 "updateTime": "A String", # Time the category was last modified in milliseconds since epoch. 181 }, 182 "errorCode": "A String", # ID that can be used to find errors in the log files. 183 "message": "A String", # Description of the operation. 184 "requestId": "A String", # ID that can be used to find request details in the log files. 185 "status": "A String", # Status of the operation. 186}</pre> 187</div> 188 189<div class="method"> 190 <code class="details" id="list">list(parent, x__xgafv=None)</code> 191 <pre>Lists the categories on the portal. 192 193Args: 194 parent: string, Required. Name of the portal. Use the following structure in your request: `organizations/{org}/sites/{site}` (required) 195 x__xgafv: string, V1 error format. 196 Allowed values 197 1 - v1 error format 198 2 - v2 error format 199 200Returns: 201 An object of the form: 202 203 { # the response for ListApiCategoriesRequest. 204 "data": [ # Details of categories. 205 { # the Api category resource. 206 "id": "A String", # ID of the category (a UUID). 207 "name": "A String", # Name of the category. 208 "siteId": "A String", # Name of the portal. 209 "updateTime": "A String", # Time the category was last modified in milliseconds since epoch. 210 }, 211 ], 212 "errorCode": "A String", # ID that can be used to find errors in the log files. 213 "message": "A String", # Description of the operation. 214 "requestId": "A String", # ID that can be used to find request details in the log files. 215 "status": "A String", # Status of the operation. 216}</pre> 217</div> 218 219<div class="method"> 220 <code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code> 221 <pre>Updates a category on the portal. 222 223Args: 224 name: string, Required. Name of the category. Use the following structure in your request: `organizations/{org}/sites/{site}/apicategories/{apicategory}` (required) 225 body: object, The request body. 226 The object takes the form of: 227 228{ # the Api category resource. 229 "id": "A String", # ID of the category (a UUID). 230 "name": "A String", # Name of the category. 231 "siteId": "A String", # Name of the portal. 232 "updateTime": "A String", # Time the category was last modified in milliseconds since epoch. 233} 234 235 x__xgafv: string, V1 error format. 236 Allowed values 237 1 - v1 error format 238 2 - v2 error format 239 240Returns: 241 An object of the form: 242 243 { # the Api category resource wrapped with response status, error_code etc. 244 "data": { # the Api category resource. # Details of category. 245 "id": "A String", # ID of the category (a UUID). 246 "name": "A String", # Name of the category. 247 "siteId": "A String", # Name of the portal. 248 "updateTime": "A String", # Time the category was last modified in milliseconds since epoch. 249 }, 250 "errorCode": "A String", # ID that can be used to find errors in the log files. 251 "message": "A String", # Description of the operation. 252 "requestId": "A String", # ID that can be used to find request details in the log files. 253 "status": "A String", # Status of the operation. 254}</pre> 255</div> 256 257</body></html>