Fields
findFields
Find fields based on their name
Parameters
| Parameter | Type | Description |
|---|---|---|
| Login | LoginObject | Standard login object with username, password, and application key |
| Name | String | String to search for |
Returns
| Return | Type | Description |
|---|---|---|
| Fields | Field[] | Array of all fields (name and external id) matching the search criteria |
Example
Request
<tns:name>Na</tns:name>
getFields
Get field names by external id
Parameters
| Parameter | Type | Description |
|---|---|---|
| Login | LoginObject | Standard login object with username, password, and application key |
| Fields | String[] | Array of external ids for the fields to get |
Returns
| Return | Type | Description |
|---|---|---|
| Fields | Field[] | Array of all fields matching the external ids provided |
Example
Request
<tns:fields>
<field>person.name</field>
</tns:fields>
getFieldDefs
Get field defintions by external id
Parameters
| Parameter | Type | Description |
|---|---|---|
| Login | LoginObject | Standard login object with username, password, and application key |
| Fields | String[] | Array of external ids for the fields to get definitions for |
Returns
| Return | Type | Description |
|---|---|---|
| Fields | FieldDefs[] | Array of all field definitions (including field type and field properties) matching the external ids provided |
Example
Request
<tns:fields>
<field>person.name</field>
</tns:fields>
getFieldKinds
Get field defintions by external id
Parameters
| Parameter | Type | Description |
|---|---|---|
| Login | LoginObject | Standard login object with username, password, and application key |
Returns
| Return | Type | Description |
|---|---|---|
| FieldKinds | String[] | Array of all field types available |
Example
Request
-
getPrimaryFields
Get primary fields for a type
Parameters
| Parameter | Type | Description |
|---|---|---|
| Login | LoginObject | Standard login object with username, password, and application key |
| Type | String | External id of the type for which to get primary fields |
Returns
| Return | Type | Description |
|---|---|---|
| Fields | String[] | Array of all primary fields on the type |
Example
Request
<tns:type>room</tns:type>
getAllFields
Get all fields for a given type, including fields on sub types
Parameters
| Parameter | Type | Description |
|---|---|---|
| Login | LoginObject | Standard login object with username, password, and application key |
| Type | String | External id of the type for which to get the fields |
Returns
| Return | Type | Description |
|---|---|---|
| Fields | String[] | Array of all fields on the type and its sub types |
Example
Request
<tns:type>room</tns:type>