1 <html><body> 2 <style> 3 4 body, 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 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, 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="admin_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.schemas.html">schemas</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#delete">delete(customerId, schemaKey)</a></code></p> 79 <p class="firstline">Delete schema</p> 80 <p class="toc_element"> 81 <code><a href="#get">get(customerId, schemaKey)</a></code></p> 82 <p class="firstline">Retrieve schema</p> 83 <p class="toc_element"> 84 <code><a href="#insert">insert(customerId, body)</a></code></p> 85 <p class="firstline">Create schema.</p> 86 <p class="toc_element"> 87 <code><a href="#list">list(customerId)</a></code></p> 88 <p class="firstline">Retrieve all schemas for a customer</p> 89 <p class="toc_element"> 90 <code><a href="#patch">patch(customerId, schemaKey, body)</a></code></p> 91 <p class="firstline">Update schema. This method supports patch semantics.</p> 92 <p class="toc_element"> 93 <code><a href="#update">update(customerId, schemaKey, body)</a></code></p> 94 <p class="firstline">Update schema</p> 95 <h3>Method Details</h3> 96 <div class="method"> 97 <code class="details" id="delete">delete(customerId, schemaKey)</code> 98 <pre>Delete schema 99 100 Args: 101 customerId: string, Immutable ID of the G Suite account (required) 102 schemaKey: string, Name or immutable Id of the schema (required) 103 </pre> 104 </div> 105 106 <div class="method"> 107 <code class="details" id="get">get(customerId, schemaKey)</code> 108 <pre>Retrieve schema 109 110 Args: 111 customerId: string, Immutable ID of the G Suite account (required) 112 schemaKey: string, Name or immutable Id of the schema (required) 113 114 Returns: 115 An object of the form: 116 117 { # JSON template for Schema resource in Directory API. 118 "fields": [ # Fields of Schema 119 { # JSON template for FieldSpec resource for Schemas in Directory API. 120 "kind": "admin#directory#schema#fieldspec", # Kind of resource this is. 121 "etag": "A String", # ETag of the resource. 122 "fieldName": "A String", # Name of the field. 123 "fieldType": "A String", # Type of the field. 124 "indexed": true, # Boolean specifying whether the field is indexed or not. 125 "readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF". 126 "numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported. 127 "maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant. 128 "minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant. 129 }, 130 "fieldId": "A String", # Unique identifier of Field (Read-only) 131 "multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not. 132 }, 133 ], 134 "kind": "admin#directory#schema", # Kind of resource this is. 135 "etag": "A String", # ETag of the resource. 136 "schemaId": "A String", # Unique identifier of Schema (Read-only) 137 "schemaName": "A String", # Schema name 138 }</pre> 139 </div> 140 141 <div class="method"> 142 <code class="details" id="insert">insert(customerId, body)</code> 143 <pre>Create schema. 144 145 Args: 146 customerId: string, Immutable ID of the G Suite account (required) 147 body: object, The request body. (required) 148 The object takes the form of: 149 150 { # JSON template for Schema resource in Directory API. 151 "fields": [ # Fields of Schema 152 { # JSON template for FieldSpec resource for Schemas in Directory API. 153 "kind": "admin#directory#schema#fieldspec", # Kind of resource this is. 154 "etag": "A String", # ETag of the resource. 155 "fieldName": "A String", # Name of the field. 156 "fieldType": "A String", # Type of the field. 157 "indexed": true, # Boolean specifying whether the field is indexed or not. 158 "readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF". 159 "numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported. 160 "maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant. 161 "minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant. 162 }, 163 "fieldId": "A String", # Unique identifier of Field (Read-only) 164 "multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not. 165 }, 166 ], 167 "kind": "admin#directory#schema", # Kind of resource this is. 168 "etag": "A String", # ETag of the resource. 169 "schemaId": "A String", # Unique identifier of Schema (Read-only) 170 "schemaName": "A String", # Schema name 171 } 172 173 174 Returns: 175 An object of the form: 176 177 { # JSON template for Schema resource in Directory API. 178 "fields": [ # Fields of Schema 179 { # JSON template for FieldSpec resource for Schemas in Directory API. 180 "kind": "admin#directory#schema#fieldspec", # Kind of resource this is. 181 "etag": "A String", # ETag of the resource. 182 "fieldName": "A String", # Name of the field. 183 "fieldType": "A String", # Type of the field. 184 "indexed": true, # Boolean specifying whether the field is indexed or not. 185 "readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF". 186 "numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported. 187 "maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant. 188 "minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant. 189 }, 190 "fieldId": "A String", # Unique identifier of Field (Read-only) 191 "multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not. 192 }, 193 ], 194 "kind": "admin#directory#schema", # Kind of resource this is. 195 "etag": "A String", # ETag of the resource. 196 "schemaId": "A String", # Unique identifier of Schema (Read-only) 197 "schemaName": "A String", # Schema name 198 }</pre> 199 </div> 200 201 <div class="method"> 202 <code class="details" id="list">list(customerId)</code> 203 <pre>Retrieve all schemas for a customer 204 205 Args: 206 customerId: string, Immutable ID of the G Suite account (required) 207 208 Returns: 209 An object of the form: 210 211 { # JSON response template for List Schema operation in Directory API. 212 "kind": "admin#directory#schemas", # Kind of resource this is. 213 "etag": "A String", # ETag of the resource. 214 "schemas": [ # List of UserSchema objects. 215 { # JSON template for Schema resource in Directory API. 216 "fields": [ # Fields of Schema 217 { # JSON template for FieldSpec resource for Schemas in Directory API. 218 "kind": "admin#directory#schema#fieldspec", # Kind of resource this is. 219 "etag": "A String", # ETag of the resource. 220 "fieldName": "A String", # Name of the field. 221 "fieldType": "A String", # Type of the field. 222 "indexed": true, # Boolean specifying whether the field is indexed or not. 223 "readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF". 224 "numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported. 225 "maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant. 226 "minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant. 227 }, 228 "fieldId": "A String", # Unique identifier of Field (Read-only) 229 "multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not. 230 }, 231 ], 232 "kind": "admin#directory#schema", # Kind of resource this is. 233 "etag": "A String", # ETag of the resource. 234 "schemaId": "A String", # Unique identifier of Schema (Read-only) 235 "schemaName": "A String", # Schema name 236 }, 237 ], 238 }</pre> 239 </div> 240 241 <div class="method"> 242 <code class="details" id="patch">patch(customerId, schemaKey, body)</code> 243 <pre>Update schema. This method supports patch semantics. 244 245 Args: 246 customerId: string, Immutable ID of the G Suite account (required) 247 schemaKey: string, Name or immutable Id of the schema. (required) 248 body: object, The request body. (required) 249 The object takes the form of: 250 251 { # JSON template for Schema resource in Directory API. 252 "fields": [ # Fields of Schema 253 { # JSON template for FieldSpec resource for Schemas in Directory API. 254 "kind": "admin#directory#schema#fieldspec", # Kind of resource this is. 255 "etag": "A String", # ETag of the resource. 256 "fieldName": "A String", # Name of the field. 257 "fieldType": "A String", # Type of the field. 258 "indexed": true, # Boolean specifying whether the field is indexed or not. 259 "readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF". 260 "numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported. 261 "maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant. 262 "minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant. 263 }, 264 "fieldId": "A String", # Unique identifier of Field (Read-only) 265 "multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not. 266 }, 267 ], 268 "kind": "admin#directory#schema", # Kind of resource this is. 269 "etag": "A String", # ETag of the resource. 270 "schemaId": "A String", # Unique identifier of Schema (Read-only) 271 "schemaName": "A String", # Schema name 272 } 273 274 275 Returns: 276 An object of the form: 277 278 { # JSON template for Schema resource in Directory API. 279 "fields": [ # Fields of Schema 280 { # JSON template for FieldSpec resource for Schemas in Directory API. 281 "kind": "admin#directory#schema#fieldspec", # Kind of resource this is. 282 "etag": "A String", # ETag of the resource. 283 "fieldName": "A String", # Name of the field. 284 "fieldType": "A String", # Type of the field. 285 "indexed": true, # Boolean specifying whether the field is indexed or not. 286 "readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF". 287 "numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported. 288 "maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant. 289 "minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant. 290 }, 291 "fieldId": "A String", # Unique identifier of Field (Read-only) 292 "multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not. 293 }, 294 ], 295 "kind": "admin#directory#schema", # Kind of resource this is. 296 "etag": "A String", # ETag of the resource. 297 "schemaId": "A String", # Unique identifier of Schema (Read-only) 298 "schemaName": "A String", # Schema name 299 }</pre> 300 </div> 301 302 <div class="method"> 303 <code class="details" id="update">update(customerId, schemaKey, body)</code> 304 <pre>Update schema 305 306 Args: 307 customerId: string, Immutable ID of the G Suite account (required) 308 schemaKey: string, Name or immutable Id of the schema. (required) 309 body: object, The request body. (required) 310 The object takes the form of: 311 312 { # JSON template for Schema resource in Directory API. 313 "fields": [ # Fields of Schema 314 { # JSON template for FieldSpec resource for Schemas in Directory API. 315 "kind": "admin#directory#schema#fieldspec", # Kind of resource this is. 316 "etag": "A String", # ETag of the resource. 317 "fieldName": "A String", # Name of the field. 318 "fieldType": "A String", # Type of the field. 319 "indexed": true, # Boolean specifying whether the field is indexed or not. 320 "readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF". 321 "numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported. 322 "maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant. 323 "minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant. 324 }, 325 "fieldId": "A String", # Unique identifier of Field (Read-only) 326 "multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not. 327 }, 328 ], 329 "kind": "admin#directory#schema", # Kind of resource this is. 330 "etag": "A String", # ETag of the resource. 331 "schemaId": "A String", # Unique identifier of Schema (Read-only) 332 "schemaName": "A String", # Schema name 333 } 334 335 336 Returns: 337 An object of the form: 338 339 { # JSON template for Schema resource in Directory API. 340 "fields": [ # Fields of Schema 341 { # JSON template for FieldSpec resource for Schemas in Directory API. 342 "kind": "admin#directory#schema#fieldspec", # Kind of resource this is. 343 "etag": "A String", # ETag of the resource. 344 "fieldName": "A String", # Name of the field. 345 "fieldType": "A String", # Type of the field. 346 "indexed": true, # Boolean specifying whether the field is indexed or not. 347 "readAccessType": "ALL_DOMAIN_USERS", # Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF". 348 "numericIndexingSpec": { # Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported. 349 "maxValue": 3.14, # Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant. 350 "minValue": 3.14, # Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant. 351 }, 352 "fieldId": "A String", # Unique identifier of Field (Read-only) 353 "multiValued": True or False, # Boolean specifying whether this is a multi-valued field or not. 354 }, 355 ], 356 "kind": "admin#directory#schema", # Kind of resource this is. 357 "etag": "A String", # ETag of the resource. 358 "schemaId": "A String", # Unique identifier of Schema (Read-only) 359 "schemaName": "A String", # Schema name 360 }</pre> 361 </div> 362 363 </body></html>
