Get
|
|||||
|
|
||||
Retrieve schema
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage the provisioning of user schemas on your domain
- View user schemas on your domain
Input
This building block consumes 2 input parameters
| Name | Format | Description |
|---|---|---|
customerId Required |
STRING |
Immutable ID of the G Suite account |
schemaKey Required |
STRING |
Name or immutable ID of the schema |
= Parameter name
= Format
|
customerId STRING Required Immutable ID of the G Suite account |
|
schemaKey STRING Required Name or immutable ID of the schema |
Output
This building block provides 18 output parameters
| Name | Format | Description |
|---|---|---|
schemaId |
STRING |
Unique identifier of Schema (Read-only) |
schemaName |
STRING |
Schema name |
fields[] |
OBJECT |
JSON template for FieldSpec resource for Schemas in Directory API. STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber) |
fields[].readAccessType |
STRING |
Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF" |
fields[].indexed |
BOOLEAN |
Boolean specifying whether the field is indexed or not |
fields[].multiValued |
BOOLEAN |
Boolean specifying whether this is a multi-valued field or not |
fields[].fieldName |
STRING |
Name of the field |
fields[].kind |
STRING |
Kind of resource this is |
fields[].numericIndexingSpec |
OBJECT |
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 |
fields[].numericIndexingSpec.minValue |
NUMBER |
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 |
fields[].numericIndexingSpec.maxValue |
NUMBER |
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 |
fields[].fieldType |
STRING |
Type of the field |
fields[].fieldId |
STRING |
Unique identifier of Field (Read-only) |
fields[].etag |
STRING |
ETag of the resource |
fields[].displayName |
STRING |
Display Name of the field |
kind |
STRING |
Kind of resource this is |
etag |
STRING |
ETag of the resource |
displayName |
STRING |
Display name for the schema |
= Parameter name
= Format
|
schemaId STRING Unique identifier of Schema (Read-only) |
|
schemaName STRING Schema name |
|
fields[] OBJECT JSON template for FieldSpec resource for Schemas in Directory API. STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber) |
|
fields[].readAccessType STRING Read ACLs on the field specifying who can view values of this field. Valid values are "ALL_DOMAIN_USERS" and "ADMINS_AND_SELF" |
|
fields[].indexed BOOLEAN Boolean specifying whether the field is indexed or not |
|
fields[].multiValued BOOLEAN Boolean specifying whether this is a multi-valued field or not |
|
fields[].fieldName STRING Name of the field |
|
fields[].kind STRING Kind of resource this is |
|
fields[].numericIndexingSpec OBJECT 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 |
|
fields[].numericIndexingSpec.minValue NUMBER 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 |
|
fields[].numericIndexingSpec.maxValue NUMBER 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 |
|
fields[].fieldType STRING Type of the field |
|
fields[].fieldId STRING Unique identifier of Field (Read-only) |
|
fields[].etag STRING ETag of the resource |
|
fields[].displayName STRING Display Name of the field |
|
kind STRING Kind of resource this is |
|
etag STRING ETag of the resource |
|
displayName STRING Display name for the schema |