Navigating Large Organization Models

Operations are provided that allow you to "drill down" into an organization model structure, rather than retrieving the entire organization model.

The following operations, which are provided in the OrgModelService, allow for improved performance over using the getOrgModel operation when retrieving a very large organization model:
  • getOrgModelRoots - Requests the details of the entities that form the root elements of the organization model identified by the given major version. These include organizations, groups, locations, capabilities, privileges, resource attributes, and model templates. Using these root entities, it is possible for the client to navigate the entire organization model in a "drill-down" fashion.
  • getOrgModelEntity - Requests the details of the entities identified by the given major version and their GUIDs. The GUIDs can be obtained using the getOrgModelRoots operation, then the details can be retrieved with this operation.

    If the identified entity has associations with other entities (for example, positions associated with an organization unit), the GUIDs of those entities are included in the response. This allows details of those entities to be retrieved.

For a list of the properties that are returned for each organizational entity type, as well as definitions for these properties, see Organization Model Entity Properties.