net.leanix.api

Class FactSheetsApi

java.lang.Object

net.leanix.api.FactSheetsApi

public class FactSheetsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
FactSheetsApi()
FactSheetsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	archiveFactSheet(String id, FactSheetArchiveParameter body) deleteFactSheet Deletes a Fact Sheet
FactSheetResponse	createFactSheet(FactSheet body) createFactSheet Creates a Fact Sheet
RelationResponse	createFactSheetRelation(FactSheetRelation relation, UUID id) createFactSheetRelation Creates the given relation with the Fact Sheet as one side of the relation.
void	deleteFactSheetRelation(UUID id, UUID relationId) deleteFactSheetRelation Deletes the given relation.
ApiClient	getApiClient()
FactSheetResponse	getFactSheet(String id, String relationTypes, Boolean permissions) getFactSheet Retrieves a Fact Sheet
RelationListResponse	getFactSheetRelations(String id, String type, Boolean withFactSheets) getFactSheetRelations Retrieves all relations of a Fact Sheet, with the given type
FactSheetListResponse	getFactSheets(String type, String relationTypes, Integer pageSize, String cursor, Boolean permissions) getFactSheets Retrieves all Fact Sheets
void	setApiClient(ApiClient apiClient)
FactSheetResponse	updateFactSheet(UUID id, FactSheet body, String relationTypes) updateFactSheet Updates a Fact Sheet
RelationResponse	updateFactSheetRelation(UUID id, UUID relationId, FactSheetRelation relation) updateFactSheetRelation Updates the given relation.

Methods inherited from class java.lang.Object

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

Constructor Detail

FactSheetsApi

public FactSheetsApi()

FactSheetsApi

public FactSheetsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

archiveFactSheet

public void archiveFactSheet(String id,
                             FactSheetArchiveParameter body)
                      throws ApiException

deleteFactSheet Deletes a Fact Sheet

Parameters:

id - (required)

body - Contains the comment and the Fact Sheet revision (optional)

Throws:

ApiException - if fails to make API call

createFactSheet

public FactSheetResponse createFactSheet(FactSheet body)
                                  throws ApiException

createFactSheet Creates a Fact Sheet

Parameters:

body - Fact Sheet to add (required)

Returns:

FactSheetResponse

Throws:

ApiException - if fails to make API call

createFactSheetRelation

public RelationResponse createFactSheetRelation(FactSheetRelation relation,
                                                UUID id)
                                         throws ApiException

createFactSheetRelation Creates the given relation with the Fact Sheet as one side of the relation. When adding constraining relations only the ID of these relations will be used.

Parameters:

relation - (required)

id - (required)

Returns:

RelationResponse

Throws:

ApiException - if fails to make API call

deleteFactSheetRelation

public void deleteFactSheetRelation(UUID id,
                                    UUID relationId)
                             throws ApiException

deleteFactSheetRelation Deletes the given relation.

Parameters:

id - (required)

relationId - (required)

Throws:

ApiException - if fails to make API call

getFactSheet

public FactSheetResponse getFactSheet(String id,
                                      String relationTypes,
                                      Boolean permissions)
                               throws ApiException

getFactSheet Retrieves a Fact Sheet

Parameters:

id - (required)

relationTypes - Comma separated list of relation types to show on the Fact Sheets (optional)

permissions - Show a permission field for the Fact Sheet (optional, default to false)

Returns:

FactSheetResponse

Throws:

ApiException - if fails to make API call

getFactSheetRelations

public RelationListResponse getFactSheetRelations(String id,
                                                  String type,
                                                  Boolean withFactSheets)
                                           throws ApiException

getFactSheetRelations Retrieves all relations of a Fact Sheet, with the given type

Parameters:

id - (required)

type - Only return relations of this type (optional)

withFactSheets - Include the to Fact Sheet in the relation (optional)

Returns:

RelationListResponse

Throws:

ApiException - if fails to make API call

getFactSheets

public FactSheetListResponse getFactSheets(String type,
                                           String relationTypes,
                                           Integer pageSize,
                                           String cursor,
                                           Boolean permissions)
                                    throws ApiException

getFactSheets Retrieves all Fact Sheets

Parameters:

type - Only list Fact Sheets with this type (optional)

relationTypes - Comma separated list of relation types to show on the Fact Sheets (optional)

pageSize - Number of Fact Sheets to return, maximum is 100 (optional, default to 40)

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

permissions - Show a permission field for the Fact Sheet (optional, default to false)

Returns:

FactSheetListResponse

Throws:

ApiException - if fails to make API call

updateFactSheet

public FactSheetResponse updateFactSheet(UUID id,
                                         FactSheet body,
                                         String relationTypes)
                                  throws ApiException

updateFactSheet Updates a Fact Sheet

Parameters:

id - (required)

body - Fact Sheet to update (required)

relationTypes - Comma separated list of relation types to update. If no types are set, the relations will not be changed. (optional)

Returns:

FactSheetResponse

Throws:

ApiException - if fails to make API call

updateFactSheetRelation

public RelationResponse updateFactSheetRelation(UUID id,
                                                UUID relationId,
                                                FactSheetRelation relation)
                                         throws ApiException

updateFactSheetRelation Updates the given relation.

Parameters:

id - (required)

relationId - (required)

relation - (required)

Returns:

RelationResponse

Throws:

ApiException - if fails to make API call