net.leanix.api

Class ModelsApi

java.lang.Object

net.leanix.api.ModelsApi

public class ModelsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ModelsApi()
ModelsApi(ApiClient apiClient)

Method Summary

Methods

Modifier and Type	Method and Description
ApiClient	getApiClient()
AuthorizationRolesResponse	getAuthorization(String workspaceId) getAuthorization Provides all authorization roles were for each role a set of permission is defined.
DataModelDefinitionResponse	getDataModel(String workspaceId) getDataModel Retrieves the model for a workspace
DataModelDefinitionResponse	getEnrichedDataModel(String workspaceId) getEnrichedDataModel Retrieves the model for a workspace, including redundant data that makes life easy for the web front end
LanguageResponse	getLanguage(String id, String workspaceId) getLanguage Get the given language
ViewModelResponse	getViewModel(String workspaceId) getViewModel Retrieves the view model for a workspace
void	setApiClient(ApiClient apiClient)
BasicResponse	updateAuthorization(List<AuthorizationRole> body, String workspaceId) updateAuthorization Updates all authorization roles for a given workspace.
DataModelUpdateResponse	updateDataModel(DataModel body, Boolean force, String workspaceId) updateDataModel Updates the data model for a workspace
BasicResponse	updateLanguage(String id, Object definition, String workspaceId) updateLanguage Updates the given language
BasicResponse	updateViewModel(String body, String workspaceId) updateViewModel Updates the view model for a workspace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ModelsApi

public ModelsApi()

ModelsApi

public ModelsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getAuthorization

public AuthorizationRolesResponse getAuthorization(String workspaceId)
                                            throws ApiException

getAuthorization Provides all authorization roles were for each role a set of permission is defined.

Parameters:

workspaceId - (optional)

Returns:

AuthorizationRolesResponse

Throws:

ApiException - if fails to make API call

getDataModel

public DataModelDefinitionResponse getDataModel(String workspaceId)
                                         throws ApiException

getDataModel Retrieves the model for a workspace

Parameters:

workspaceId - (optional)

Returns:

DataModelDefinitionResponse

Throws:

ApiException - if fails to make API call

getEnrichedDataModel

public DataModelDefinitionResponse getEnrichedDataModel(String workspaceId)
                                                 throws ApiException

getEnrichedDataModel Retrieves the model for a workspace, including redundant data that makes life easy for the web front end

Parameters:

workspaceId - (optional)

Returns:

DataModelDefinitionResponse

Throws:

ApiException - if fails to make API call

getLanguage

public LanguageResponse getLanguage(String id,
                           String workspaceId)
                             throws ApiException

getLanguage Get the given language

Parameters:

id - (required)

workspaceId - (optional)

Returns:

LanguageResponse

Throws:

ApiException - if fails to make API call

getViewModel

public ViewModelResponse getViewModel(String workspaceId)
                               throws ApiException

getViewModel Retrieves the view model for a workspace

Parameters:

workspaceId - (optional)

Returns:

ViewModelResponse

Throws:

ApiException - if fails to make API call

updateAuthorization

public BasicResponse updateAuthorization(List<AuthorizationRole> body,
                                String workspaceId)
                                  throws ApiException

updateAuthorization Updates all authorization roles for a given workspace. This means all existing roles and its permissions will be overriden

Parameters:

body - The authorization configuration for the workspace which contains all roles and its permissions (required)

workspaceId - (optional)

Returns:

BasicResponse

Throws:

ApiException - if fails to make API call

updateDataModel

public DataModelUpdateResponse updateDataModel(DataModel body,
                                      Boolean force,
                                      String workspaceId)
                                        throws ApiException

updateDataModel Updates the data model for a workspace

Parameters:

body - the data model for the workspace (required)

force - whether changes should be forced (optional, default to false)

workspaceId - (optional)

Returns:

DataModelUpdateResponse

Throws:

ApiException - if fails to make API call

updateLanguage

public BasicResponse updateLanguage(String id,
                           Object definition,
                           String workspaceId)
                             throws ApiException

updateLanguage Updates the given language

Parameters:

id - (required)

definition - (required)

workspaceId - (optional)

Returns:

BasicResponse

Throws:

ApiException - if fails to make API call

updateViewModel

public BasicResponse updateViewModel(String body,
                            String workspaceId)
                              throws ApiException

updateViewModel Updates the view model for a workspace

Parameters:

body - the view model for the workspace (required)

workspaceId - (optional)

Returns:

BasicResponse

Throws:

ApiException - if fails to make API call