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

Modifier and Type	Method and Description
AccessControlEntityResponse	createAccessControlEntity(AccessControlEntity body) createAccessControlEntity Creates an access control entity
void	deleteAccessControlEntity(UUID id) deleteAccessControlEntity Deletes an access control entity
AccessControlEntityListResponse	getAccessControlEntities(Integer pageSize, String cursor, String sorting, String sortDirection) getAccessControlEntities Retrieves all access control entities
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
ReportingModelResponse	getReportingModel(String workspaceId) getReportingModel Retrieves the report model for a workspace
ViewModelResponse	getViewModel(String workspaceId) getViewModel Retrieves the view model for a workspace
AccessControlEntityResponse	readAccessControlEntity(UUID id) getAccessControlEntity Reads an access control entity
void	setApiClient(ApiClient apiClient)
AccessControlEntityResponse	updateAccessControlEntity(UUID id, AccessControlEntity accessControlEntity) updateAccessControlEntity Updates an access control entity
Response	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
Response	updateLanguage(String id, Translation definition, String workspaceId) updateLanguage Updates the given language
void	updateReportingModel(ReportingModelDefinition body, String workspaceId) updateReportingModel Updates the report model for a workspace
void	updateViewModel(ViewModelDefinition 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)

createAccessControlEntity

public AccessControlEntityResponse createAccessControlEntity(AccessControlEntity body)
                                                      throws ApiException

createAccessControlEntity Creates an access control entity

Parameters:

body - New access control entity (optional)

Returns:

AccessControlEntityResponse

Throws:

ApiException - if fails to make API call

deleteAccessControlEntity

public void deleteAccessControlEntity(UUID id)
                               throws ApiException

deleteAccessControlEntity Deletes an access control entity

Parameters:

id - (required)

Throws:

ApiException - if fails to make API call

getAccessControlEntities

public AccessControlEntityListResponse getAccessControlEntities(Integer pageSize,
                                                                String cursor,
                                                                String sorting,
                                                                String sortDirection)
                                                         throws ApiException

getAccessControlEntities Retrieves all access control entities

Parameters:

pageSize - Number of reports to be returned, maximum is 100 (optional, default to 40)

cursor - Marks the position of the first element that should be returned (optional)

sorting - The field to sort the results by (optional, default to name)

sortDirection - The direction of the sorting (optional, default to ASC)

Returns:

AccessControlEntityListResponse

Throws:

ApiException - if fails to make API call

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

getReportingModel

public ReportingModelResponse getReportingModel(String workspaceId)
                                         throws ApiException

getReportingModel Retrieves the report model for a workspace

Parameters:

workspaceId - (optional)

Returns:

ReportingModelResponse

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

readAccessControlEntity

public AccessControlEntityResponse readAccessControlEntity(UUID id)
                                                    throws ApiException

getAccessControlEntity Reads an access control entity

Parameters:

id - (required)

Returns:

AccessControlEntityResponse

Throws:

ApiException - if fails to make API call

updateAccessControlEntity

public AccessControlEntityResponse updateAccessControlEntity(UUID id,
                                                             AccessControlEntity accessControlEntity)
                                                      throws ApiException

updateAccessControlEntity Updates an access control entity

Parameters:

id - (required)

accessControlEntity - (optional)

Returns:

AccessControlEntityResponse

Throws:

ApiException - if fails to make API call

updateAuthorization

public Response 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:

Response

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 Response updateLanguage(String id,
                               Translation definition,
                               String workspaceId)
                        throws ApiException

updateLanguage Updates the given language

Parameters:

id - (required)

definition - (required)

workspaceId - (optional)

Returns:

Response

Throws:

ApiException - if fails to make API call

updateReportingModel

public void updateReportingModel(ReportingModelDefinition body,
                                 String workspaceId)
                          throws ApiException

updateReportingModel Updates the report model for a workspace

Parameters:

body - the report model for the workspace (required)

workspaceId - (optional)

Throws:

ApiException - if fails to make API call

updateViewModel

public void updateViewModel(ViewModelDefinition body,
                            String workspaceId)
                     throws ApiException

updateViewModel Updates the view model for a workspace

Parameters:

body - the view model for the workspace (required)

workspaceId - (optional)

Throws:

ApiException - if fails to make API call