To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Properties
| Name | Returns | Notes | Example |
|---|---|---|---|
| adminOrg | Organisation | Returns the current account organisation | |
| allLocales | List | ||
| timezoneIdList | List | ||
| allOrgTypes | List | ||
| primaryDomain | String |
Methods
| Name | Returns | Notes | Example |
|---|---|---|---|
| createAccount ( company, profile ) | Organisation | ||
| hasOrgType ( orgTypeName, org ) | boolean | ||
| findOrg ( orgId ) | Organisation | ||
| findOrg ( id ) | Organisation | ||
| createOrg ( parent, orgId, orgTitle ) | Organisation | Creates the new org as a child of the given parent (if not null, otherwise creates directly under the current account org), and submits for reindexing | |
| updateOrg ( org ) | void | Just saves and submits for reindexing | |
| deleteOrg ( org ) | void | Does a soft delete, and updates search index | |
| findDuplicates ( mode ) | List | ||
| mergeOrgs ( mergeDestId, mergeOrgIds ) | int | Returns the number deleted | |
| addOrgType ( org, orgType ) | void | ||
| removeOrgType ( org, orgType ) | void | ||
| getOrgType ( name ) | OrgType | ||
| getOrgTypeExtraFields ( orgType ) | Map | Deprecated method, use findOrgTypeExtraFields instead | |
| findOrgTypeExtraFields ( orgType ) | List | ||
| findOrgTypeExtraFieldMeta ( orgType ) | Map | Returns a map of raw extra field meta data, ie as a formatted text, keyed on the field name | |
| updateOrgExtraFields ( org, orgTypes, fc ) | void | Saves new custom field values for the given Organisation | |
| findOrgTypeById ( orgTypeId ) | OrgType | ||
| findOrgTypeByName ( sOrgType ) | OrgType | ||
| save ( orgToEdit ) | void | ||
| findOrgsByType ( ot ) | List | Finds non-soft deleted orgs only, of the given type | |
| search ( q, organisation, orgType ) | List | Finds orgs, of the given query string, parent organisation and org types | |
| searchES ( query, parentOrgs, orgTypes, noOrgType, searchProperties, excludedOrgId ) | KSearchResponse | Standard search method for finding orgs in elasticsearch | |
| findMatching ( request ) | List | ||
| newAddressBean ( ) | AddressBean | Create a new instance of AddressBean | |
| findDirectSubordinateOrgs ( superordinate ) | List |
Return a list of organisations which are logically subordinate to the
given superordinate org.
An org is considered a direct subordinate if:
|
|
| toOrgDataList ( orgs ) | List | Converts list of Organisation to list of OrgData | |
| toOrgData ( org ) | OrgData | ||
| toOrgMapData ( hit, distanceUnit ) | OrgMapData | ||
| createOrgType ( name, title ) | OrgType | ||
| deleteOrgType ( type ) | boolean | Safely delete organisation type | |
| findAuditStats ( org ) | Map | Returns the number of changes to the given item by Date | |
| findAuditItems ( org, max ) | List | ||
| updateOrgType ( orgType, context ) | OrgType | Update orgtype with a form context | |
| findOrgsById ( ids, enabled ) | List | Find orgs with the given IDs. This method will use multiple queries if necessary in batches of 100's. Will only match profiles which are subordinate to the tenant org | |
| hasParent ( org, adminDomainId ) | boolean | Check if the given org has a parent with the specified admin domain name | |
| findExtraFieldNames ( ) | List | Get an alphabetically sorted list of extra fields defined in all organisation types |
© 2025 Kademi Ltd