Fields

findFields

Find fields based on their name

Parameter	Type	Description
Login	LoginObject	Standard login object with username, password, and application key
Name	String	String to search for

Return	Type	Description
Fields	Field[]	Array of all fields (name and external id) matching the search criteria

Request

<tns:name>Na</tns:name>

Get field names by external id

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

Return	Type	Description
Fields	Field[]	Array of all fields matching the external ids provided

Request

<tns:fields>
  <field>person.name</field>
</tns:fields>

Get field defintions by external id

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

Return	Type	Description
Fields	FieldDefs[]	Array of all field definitions (including field type and field properties) matching the external ids provided

Request

<tns:fields>
  <field>person.name</field>
</tns:fields>

Get field defintions by external id

Parameter	Type	Description
Login	LoginObject	Standard login object with username, password, and application key

Return	Type	Description
FieldKinds	String[]	Array of all field types available

Request

Get primary fields for a type

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

Return	Type	Description
Fields	String[]	Array of all primary fields on the type

Request

<tns:type>room</tns:type>

Get all fields for a given type, including fields on sub types

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

Return	Type	Description
Fields	String[]	Array of all fields on the type and its sub types

Request

<tns:type>room</tns:type>