| Package | Description |
|---|---|
| net.leanix.api | |
| net.leanix.api.common | |
| net.leanix.api.common.auth |
| Modifier and Type | Method and Description |
|---|---|
void |
FactSheetsApi.archiveFactSheet(String id,
FactSheetArchiveParameter body)
deleteFactSheet
Deletes a Fact Sheet
|
AccessControlEntityResponse |
ModelsApi.createAccessControlEntity(AccessControlEntity body)
createAccessControlEntity
Creates an access control entity
|
BookmarkResponse |
BookmarksApi.createBookmark(Bookmark body)
createBookmark
Saves a bookmark in the database
|
BookmarkSharesResponse |
BookmarkSharesApi.createBookmarkShare(BookmarkShareInputData bookmarkShare)
createBookmarkShares
Saves a bookmark share in the database
|
JobResponse |
ExportsApi.createExportFile()
createExportFile
Creates an excel export file by using the given graphQL query and table configuration
|
FactSheetResponse |
FactSheetsApi.createFactSheet(FactSheet body)
createFactSheet
Creates a Fact Sheet
|
RelationResponse |
FactSheetsApi.createFactSheetRelation(FactSheetRelation relation,
UUID id)
createFactSheetRelation
Creates the given relation with the Fact Sheet as one side of the relation.
|
JobResponse |
ExportsApi.createFullExport(String exportType,
String startDate,
String endDate)
createFullExport
Creates a full export of the workspace data, or an export of the changelog, depending on given type
|
TodoResponse |
TodosApi.createTodo(TodoData body,
UUID workspaceId)
createTodo
Saves a todo in the database
|
void |
ModelsApi.deleteAccessControlEntity(UUID id)
deleteAccessControlEntity
Deletes an access control entity
|
void |
AssetsApi.deleteAsset(String asset)
deleteAsset
Delete an asset
|
void |
BookmarksApi.deleteBookmark(UUID id)
deleteBookmark
Deletes a bookmark identified by the given ID
|
void |
BookmarkSharesApi.deleteBookmarkShare(UUID bookmarkId,
UUID sharedWithUserId)
deleteBookmarkShares
Deletes a bookmark share by the calling user.
|
void |
FactSheetsApi.deleteFactSheetRelation(UUID id,
UUID relationId)
deleteFactSheetRelation
Deletes the given relation.
|
void |
TodosApi.deleteTodo(UUID id,
UUID workspaceId)
deleteTodo
deletes a todo item based on provided id.
|
BookmarkResponse |
BookmarksApi.deleteWorkingCopy(UUID id)
deleteWorkingCopy
Deletes a working copy for a bookmark stored in the database
|
void |
AssetsApi.downloadAsset(String asset)
downloadAsset
Download an asset
|
void |
DocumentsApi.downloadDocument(String documentId)
downloadDocument
Download a document's content
|
void |
ExportsApi.downloadExportFile(String workspaceId,
String key)
downloadExportFile
Returns the download file for the given ID
|
AccessControlEntityListResponse |
ModelsApi.getAccessControlEntities(Integer pageSize,
String cursor,
String sorting,
String sortDirection)
getAccessControlEntities
Retrieves all access control entities
|
AuthorizationRolesResponse |
ModelsApi.getAuthorization(String workspaceId)
getAuthorization
Provides all authorization roles were for each role a set of permission is defined.
|
BookmarkResponse |
BookmarksApi.getBookmark(UUID id,
Boolean markAsViewed)
getBookmark
Retrieves a bookmark by ID
|
BookmarkListResponse |
BookmarksApi.getBookmarks(String bookmarkType,
String groupKey)
getBookmarks
Retrieves all stored bookmarks a user can read.
|
BookmarkSharesResponse |
BookmarkSharesApi.getBookmarkShares(UUID bookmarkId)
getBookmarkShares
Retrieves all stored bookmark shared by the calling user.
|
BookmarkSuggestionsResponse |
SearchbookmarksApi.getBookmarkSuggestions(String type,
String subtype,
String q,
Boolean personalized,
String sort,
List<String> cursor,
Integer pageSize,
String sortDirection,
UUID factSheetId,
Boolean predefinedOnly)
getBookmarkSuggestions
Returns a list of bookmark suggestions for a given search term or all the bookmarks matching filter
|
DataModelDefinitionResponse |
ModelsApi.getDataModel(String workspaceId)
getDataModel
Retrieves the model for a workspace
|
DataModelDefinitionResponse |
ModelsApi.getEnrichedDataModel(String workspaceId)
getEnrichedDataModel
Retrieves the model for a workspace, including redundant data that makes life easy for the web front end
|
ExportListResponse |
ExportsApi.getExports(String exportType,
UUID userId,
Integer pageSize,
String cursor,
String sorting,
String sortDirection)
getExports
Lists all exports of the given type in the workspace of the authorized user
|
FactSheetResponse |
FactSheetsApi.getFactSheet(String id,
String relationTypes,
Boolean permissions)
getFactSheet
Retrieves a Fact Sheet
|
RelationListResponse |
FactSheetsApi.getFactSheetRelations(String id,
String type,
Boolean withFactSheets)
getFactSheetRelations
Retrieves all relations of a Fact Sheet, with the given type
|
FactSheetListResponse |
FactSheetsApi.getFactSheets(String type,
String relationTypes,
Integer pageSize,
String cursor,
Boolean permissions)
getFactSheets
Retrieves all Fact Sheets
|
FeatureListResponse |
FeaturesApi.getFeatures()
getFeatures
Retrieves features for a workspace
|
LanguageResponse |
ModelsApi.getLanguage(String id,
String workspaceId)
getLanguage
Get the given language
|
FactSheetSettingsResponse |
SettingsApi.getModelCustomization(String factSheetType)
getFactSheetSettings
|
ReportingModelResponse |
ModelsApi.getReportingModel(String workspaceId)
getReportingModel
Retrieves the report model for a workspace
|
SettingsResponse |
SettingsApi.getSettings()
getSettings
|
SuggestionsResponse |
SuggestionsApi.getSuggestions(String q,
String object,
Integer count,
Boolean perType)
getSuggestions
Retrieves a list of suggestions for a search term
|
TodoResponse |
TodosApi.getTodo(UUID id)
getTodo
Retrieves a todo by ID
|
TodoListResponse |
TodosApi.getTodos(String type,
String status,
UUID factSheetId,
UUID userId,
UUID workspaceId,
Boolean getArchived,
Integer size,
Integer page)
getTodos
Retrieves all todos a user can read.
|
ViewModelResponse |
ModelsApi.getViewModel(String workspaceId)
getViewModel
Retrieves the view model for a workspace
|
GraphQLResult |
GraphqlApi.processGraphQL(GraphQLRequest request)
processGraphQL
Processes GraphQL requests
|
GraphQLResult |
GraphqlApi.processGraphQLMultipart(String graphQLRequest,
File file)
processGraphQLMultipart
Processes GraphQL requests, supporting multipart documents
|
AccessControlEntityResponse |
ModelsApi.readAccessControlEntity(UUID id)
getAccessControlEntity
Reads an access control entity
|
AccessControlEntityResponse |
ModelsApi.updateAccessControlEntity(UUID id,
AccessControlEntity accessControlEntity)
updateAccessControlEntity
Updates an access control entity
|
Response |
ModelsApi.updateAuthorization(List<AuthorizationRole> body,
String workspaceId)
updateAuthorization
Updates all authorization roles for a given workspace.
|
BookmarkResponse |
BookmarksApi.updateBookmark(UUID id,
Bookmark body)
updateBookmark
Updates a bookmark stored in the database
|
DataModelUpdateResponse |
ModelsApi.updateDataModel(DataModel body,
Boolean force,
String workspaceId)
updateDataModel
Updates the data model for a workspace
|
FactSheetResponse |
FactSheetsApi.updateFactSheet(UUID id,
FactSheet body,
String relationTypes)
updateFactSheet
Updates a Fact Sheet
|
RelationResponse |
FactSheetsApi.updateFactSheetRelation(UUID id,
UUID relationId,
FactSheetRelation relation)
updateFactSheetRelation
Updates the given relation.
|
Response |
ModelsApi.updateLanguage(String id,
Translation definition,
String workspaceId)
updateLanguage
Updates the given language
|
void |
SettingsApi.updateModelsWithCustomization(String factSheetType,
FactSheetSettings body)
putFactSheetSettings
|
void |
ModelsApi.updateReportingModel(ReportingModelDefinition body,
String workspaceId)
updateReportingModel
Updates the report model for a workspace
|
Response |
SettingsApi.updateSettings(WorkspaceSettings body)
updateSettings
|
TodoResponse |
TodosApi.updateTodo(UUID id,
UUID workspaceId,
TodoData body)
updateTodo
Updates a todo stored in the database.
|
void |
ModelsApi.updateViewModel(ViewModelDefinition body,
String workspaceId)
updateViewModel
Updates the view model for a workspace
|
BookmarkResponse |
BookmarksApi.updateWorkingCopy(UUID id,
BookmarkWorkingCopy body)
updateWorkingCopy
Updates a working copy for a bookmark stored in the database
|
void |
AssetsApi.upsertAsset(String asset)
upsertAsset
Upsert an asset
|
| Modifier and Type | Method and Description |
|---|---|
<T> T |
ApiClient.deserialize(javax.ws.rs.core.Response response,
javax.ws.rs.core.GenericType<T> returnType)
Deserialize response body to Java object according to the Content-Type.
|
File |
ApiClient.downloadFileFromResponse(javax.ws.rs.core.Response response)
Download file from the given response.
|
<T> T |
ApiClient.invokeAPI(String path,
String method,
List<Pair> queryParams,
Object body,
Map<String,String> headerParams,
Map<String,Object> formParams,
String accept,
String contentType,
String[] authNames,
javax.ws.rs.core.GenericType<T> returnType)
Invoke API by sending HTTP request with the given options.
|
javax.ws.rs.client.Entity<?> |
ApiClient.serialize(Object obj,
Map<String,Object> formParams,
String contentType)
Serialize the given Java object into string entity according the given
Content-Type (only JSON is supported for now).
|
| Modifier and Type | Method and Description |
|---|---|
void |
ClientCredentialRefreshingOAuth.applyToParams(List<Pair> queryParams,
Map<String,String> headerParams) |
void |
Authentication.applyToParams(List<Pair> queryParams,
Map<String,String> headerParams)
Apply authentication settings to header and query params.
|
void |
OAuth.applyToParams(List<Pair> queryParams,
Map<String,String> headerParams) |
Copyright © 2019 LeanIX GmbH. All rights reserved.