Skip to content

Latest commit

 

History

History
9587 lines (6927 loc) · 101 KB

reference.md

File metadata and controls

9587 lines (6927 loc) · 101 KB

Reference

Comments

client.comments.list(landscapeId, versionId) -> CommentsListResponse

🔌 Usage

client.comments().list(
    CommentsListRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

status: Optional<String>

client.comments.create(landscapeId, versionId, request) -> CommentsCreateResponse

🔌 Usage

client.comments().create(
    CommentCreateRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .body(
            CommentRequired
                .builder()
                .body(
                    CommentBody.of(
                        CommentBodyQuestion
                            .builder()
                            .content("content")
                            .status(CommentBodyQuestionStatus.OPEN)
                            .type(CommentBodyQuestionType.QUESTION)
                            .build()
                    )
                )
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

request: CommentRequired

client.comments.get(landscapeId, versionId, commentId) -> CommentsGetResponse

🔌 Usage

client.comments().get(
    CommentFindRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .commentId("commentId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

commentId: String

client.comments.upsert(landscapeId, versionId, commentId, request) -> CommentsUpsertResponse

🔌 Usage

client.comments().upsert(
    CommentUpsertRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .commentId("commentId")
        .body(
            CommentUpsert
                .builder()
                .body(
                    CommentBody.of(
                        CommentBodyQuestion
                            .builder()
                            .content("content")
                            .status(CommentBodyQuestionStatus.OPEN)
                            .type(CommentBodyQuestionType.QUESTION)
                            .build()
                    )
                )
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

commentId: String

request: CommentUpsert

client.comments.delete(landscapeId, versionId, commentId) -> CommentsDeleteResponse

🔌 Usage

client.comments().delete(
    CommentDeleteRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .commentId("commentId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

commentId: String

client.comments.update(landscapeId, versionId, commentId, request) -> CommentsUpdateResponse

🔌 Usage

client.comments().update(
    CommentUpdateRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .commentId("commentId")
        .body(
            CommentPartial
                .builder()
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

commentId: String

request: CommentPartial

Diagrams

client.diagrams.list(landscapeId, versionId) -> DiagramsListResponse

🔌 Usage

client.diagrams().list(
    DiagramsListRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

filter: Optional<DiagramFilter>

client.diagrams.create(landscapeId, versionId, request) -> DiagramsCreateResponse

🔌 Usage

client.diagrams().create(
    DiagramCreateRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .body(
            DiagramCreate
                .builder()
                .index(1.1)
                .modelId("modelId")
                .name("name")
                .type(DiagramType.APP_DIAGRAM)
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

updateViewedAt: Optional<Boolean>

request: DiagramCreate

client.diagrams.get(landscapeId, versionId, diagramId) -> DiagramsGetResponse

🔌 Usage

client.diagrams().get(
    DiagramFindRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .diagramId("diagramId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

diagramId: String

updateViewedAt: Optional<Boolean>

client.diagrams.upsert(landscapeId, versionId, diagramId, request) -> DiagramsUpsertResponse

🔌 Usage

client.diagrams().upsert(
    DiagramUpsertRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .diagramId("diagramId")
        .body(
            DiagramCreate
                .builder()
                .index(1.1)
                .modelId("modelId")
                .name("name")
                .type(DiagramType.APP_DIAGRAM)
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

diagramId: String

updateViewedAt: Optional<Boolean>

request: DiagramCreate

client.diagrams.delete(landscapeId, versionId, diagramId) -> DiagramsDeleteResponse

🔌 Usage

client.diagrams().delete(
    DiagramDeleteRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .diagramId("diagramId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

diagramId: String

updateViewedAt: Optional<Boolean>

client.diagrams.update(landscapeId, versionId, diagramId, request) -> DiagramsUpdateResponse

🔌 Usage

client.diagrams().update(
    DiagramUpdateRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .diagramId("diagramId")
        .body(
            DiagramUpsert
                .builder()
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

diagramId: String

updateViewedAt: Optional<Boolean>

request: DiagramUpsert

client.diagrams.exists(landscapeId, versionId, diagramId)

🔌 Usage

client.diagrams().exists(
    DiagramExistsRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .diagramId("diagramId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

diagramId: String

updateViewedAt: Optional<Boolean>

client.diagrams.listThumbnails(landscapeId, versionId) -> DiagramsListThumbnailsResponse

🔌 Usage

client.diagrams().listThumbnails(
    DiagramThumbnailsListRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

filter: Optional<DiagramFilter>

client.diagrams.getThumbnail(landscapeId, versionId, diagramId) -> DiagramsGetThumbnailResponse

🔌 Usage

client.diagrams().getThumbnail(
    DiagramThumbnailGetRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .diagramId("diagramId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

diagramId: String

Domains

client.domains.list(landscapeId, versionId) -> DomainsListResponse

🔌 Usage

client.domains().list(
    DomainsListRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

filter: Optional<DomainFilter>

client.domains.create(landscapeId, versionId, request) -> DomainsCreateResponse

🔌 Usage

client.domains().create(
    DomainCreateRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .body(
            DomainRequired
                .builder()
                .name("name")
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

request: DomainRequired

client.domains.get(landscapeId, versionId, domainId) -> DomainsGetResponse

🔌 Usage

client.domains().get(
    DomainFindRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .domainId("domainId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

domainId: String

client.domains.upsert(landscapeId, versionId, domainId, request) -> DomainsUpsertResponse

🔌 Usage

client.domains().upsert(
    DomainUpsertRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .domainId("domainId")
        .body(
            DomainUpsert
                .builder()
                .name("name")
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

domainId: String

request: DomainUpsert

client.domains.delete(landscapeId, versionId, domainId) -> DomainsDeleteResponse

🔌 Usage

client.domains().delete(
    DomainDeleteRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .domainId("domainId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

domainId: String

client.domains.update(landscapeId, versionId, domainId, request) -> DomainsUpdateResponse

🔌 Usage

client.domains().update(
    DomainUpdateRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .domainId("domainId")
        .body(
            DomainPartial
                .builder()
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

domainId: String

request: DomainPartial

client.domains.exists(landscapeId, versionId, domainId)

🔌 Usage

client.domains().exists(
    DomainExistsRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .domainId("domainId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

domainId: String

Drafts

client.drafts.list(landscapeId, versionId) -> DraftsListResponse

🔌 Usage

client.drafts().list(
    DraftsListRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

filter: Optional<DraftFilter>

client.drafts.create(landscapeId, versionId, request) -> DraftsCreateResponse

🔌 Usage

client.drafts().create(
    DraftCreateRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .body(
            DraftRequired
                .builder()
                .name("name")
                .status(DraftStatus.IN_PROGRESS)
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

request: DraftRequired

client.drafts.get(landscapeId, versionId, draftId) -> DraftsGetResponse

🔌 Usage

client.drafts().get(
    DraftFindRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .draftId("draftId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

draftId: String

client.drafts.upsert(landscapeId, versionId, draftId, request) -> DraftsUpsertResponse

🔌 Usage

client.drafts().upsert(
    DraftUpsertRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .draftId("draftId")
        .body(
            DraftRequired
                .builder()
                .name("name")
                .status(DraftStatus.IN_PROGRESS)
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

draftId: String

request: DraftRequired

client.drafts.delete(landscapeId, versionId, draftId) -> Map&lt;String, Object&gt;

🔌 Usage

client.drafts().delete(
    DraftDeleteRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .draftId("draftId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

draftId: String

client.drafts.update(landscapeId, versionId, draftId, request) -> DraftsUpdateResponse

🔌 Usage

client.drafts().update(
    DraftUpdateRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .draftId("draftId")
        .body(
            DraftPartial
                .builder()
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

draftId: String

request: DraftPartial

client.drafts.merge(landscapeId, versionId, draftId) -> DraftsMergeResponse

🔌 Usage

client.drafts().merge(
    DraftMergeRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .draftId("draftId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

draftId: String

Flows

client.flows.list(landscapeId, versionId) -> FlowsListResponse

🔌 Usage

client.flows().list(
    FlowsListRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

filter: Optional<FlowFilter>

client.flows.create(landscapeId, versionId, request) -> FlowsCreateResponse

🔌 Usage

client.flows().create(
    FlowCreateRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .body(
            FlowRequired
                .builder()
                .name("name")
                .diagramId("diagramId")
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

request: FlowRequired

client.flows.get(landscapeId, versionId, flowId) -> FlowsGetResponse

🔌 Usage

client.flows().get(
    FlowFindRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .flowId("flowId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

flowId: String

client.flows.upsert(landscapeId, versionId, flowId, request) -> FlowsUpsertResponse

🔌 Usage

client.flows().upsert(
    FlowUpsertRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .flowId("flowId")
        .body(
            FlowRequired
                .builder()
                .name("name")
                .diagramId("diagramId")
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

flowId: String

request: FlowRequired

client.flows.delete(landscapeId, versionId, flowId) -> FlowsDeleteResponse

🔌 Usage

client.flows().delete(
    FlowDeleteRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .flowId("flowId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

flowId: String

client.flows.update(landscapeId, versionId, flowId, request) -> FlowsUpdateResponse

🔌 Usage

client.flows().update(
    FlowUpdateRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .flowId("flowId")
        .body(
            FlowPartial
                .builder()
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

flowId: String

request: FlowPartial

client.flows.exists(landscapeId, versionId, flowId)

🔌 Usage

client.flows().exists(
    FlowExistsRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .flowId("flowId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

flowId: String

client.flows.listThumbnails(landscapeId, versionId) -> FlowsListThumbnailsResponse

🔌 Usage

client.flows().listThumbnails(
    FlowThumbnailsListRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

filter: Optional<DiagramFilter>

client.flows.getThumbnail(landscapeId, versionId, flowId) -> FlowsGetThumbnailResponse

🔌 Usage

client.flows().getThumbnail(
    FlowThumbnailGetRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .flowId("flowId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

flowId: String

Landscapes

client.landscapes.get(landscapeId) -> LandscapesGetResponse

🔌 Usage

client.landscapes().get(
    LandscapeFindRequest
        .builder()
        .landscapeId("landscapeId")
        .build()
);

⚙️ Parameters

landscapeId: String

client.landscapes.delete(landscapeId) -> Map&lt;String, Object&gt;

🔌 Usage

client.landscapes().delete(
    LandscapeDeleteRequest
        .builder()
        .landscapeId("landscapeId")
        .build()
);

⚙️ Parameters

landscapeId: String

client.landscapes.update(landscapeId, request) -> LandscapesUpdateResponse

🔌 Usage

client.landscapes().update(
    LandscapeUpdateRequest
        .builder()
        .landscapeId("landscapeId")
        .body(
            LandscapePartial
                .builder()
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

request: LandscapePartial

client.landscapes.duplicate(landscapeId, request) -> LandscapesDuplicateResponse

🔌 Usage

client.landscapes().duplicate(
    LandscapeDuplicateRequest
        .builder()
        .landscapeId("landscapeId")
        .body(
            LandscapeRequired
                .builder()
                .name("name")
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

targetOrganizationId: Optional<String>

request: LandscapeRequired

client.landscapes.copy(landscapeId) -> Map&lt;String, Object&gt;

🔌 Usage

client.landscapes().copy(
    LandscapeCopyRequest
        .builder()
        .landscapeId("landscapeId")
        .targetLandscapeId("targetLandscapeId")
        .build()
);

⚙️ Parameters

landscapeId: String

targetLandscapeId: String

client.landscapes.search(landscapeId, versionId) -> LandscapesSearchResponse

📝 Description

Search the entire landscape

🔌 Usage

client.landscapes().search(
    LandscapeSearchRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .search("search")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

search: String

filter: Optional<SearchFilter>

includeData: Optional<Boolean>

maxResults: Optional<Double>

Organizations

client.organizations.list() -> OrganizationsListResponse

🔌 Usage

client.organizations().list(
    OrganizationsListRequest
        .builder()
        .build()
);

⚙️ Parameters

admin: Optional<Boolean> — list all organizations on the platform

client.organizations.create(request) -> OrganizationsCreateResponse

🔌 Usage

client.organizations().create(
    OrganizationRequired
        .builder()
        .name("name")
        .build()
);

⚙️ Parameters

request: OrganizationRequired

client.organizations.get(organizationId) -> OrganizationsGetResponse

🔌 Usage

client.organizations().get(
    OrganizationFindRequest
        .builder()
        .organizationId("organizationId")
        .build()
);

⚙️ Parameters

organizationId: String

client.organizations.delete(organizationId) -> Map&lt;String, Object&gt;

🔌 Usage

client.organizations().delete(
    OrganizationDeleteRequest
        .builder()
        .organizationId("organizationId")
        .build()
);

⚙️ Parameters

organizationId: String

client.organizations.update(organizationId, request) -> OrganizationsUpdateResponse

🔌 Usage

client.organizations().update(
    OrganizationUpdateRequest
        .builder()
        .organizationId("organizationId")
        .body(
            OrganizationPartial
                .builder()
                .build()
        )
        .build()
);

⚙️ Parameters

organizationId: String

request: OrganizationPartial

ShareLink

client.shareLink.get(landscapeId, versionId) -> ShareLinkGetResponse

🔌 Usage

client.shareLink().get(
    ShareLinkFindRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

client.shareLink.create(landscapeId, versionId, request) -> ShareLinkCreateResponse

🔌 Usage

client.shareLink().create(
    ShareLinkCreateRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .body(
            ShareLinkRequired
                .builder()
                .protected_(true)
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

request: ShareLinkRequired

client.shareLink.delete(landscapeId, versionId) -> Map&lt;String, Object&gt;

🔌 Usage

client.shareLink().delete(
    ShareLinkDeleteRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

client.shareLink.update(landscapeId, versionId, request) -> ShareLinkUpdateResponse

🔌 Usage

client.shareLink().update(
    ShareLinkUpdateRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .body(
            ShareLinkPartial
                .builder()
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

resetShortId: Optional<Boolean>

request: ShareLinkPartial

Tags

client.tags.list(landscapeId, versionId) -> TagsListResponse

🔌 Usage

client.tags().list(
    TagsListRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

filter: Optional<TagFilter>

client.tags.create(landscapeId, versionId, request) -> TagsCreateResponse

🔌 Usage

client.tags().create(
    TagCreateRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .body(
            TagRequired
                .builder()
                .color(TagColor.BLUE)
                .groupId("groupId")
                .index(1.1)
                .name("name")
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

request: TagRequired

client.tags.get(landscapeId, versionId, tagId) -> TagsGetResponse

🔌 Usage

client.tags().get(
    TagFindRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .tagId("tagId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

tagId: String

client.tags.upsert(landscapeId, versionId, tagId, request) -> TagsUpsertResponse

🔌 Usage

client.tags().upsert(
    TagUpsertRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .tagId("tagId")
        .body(
            TagUpsert
                .builder()
                .color(TagColor.BLUE)
                .groupId("groupId")
                .index(1.1)
                .name("name")
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

tagId: String

request: TagUpsert

client.tags.delete(landscapeId, versionId, tagId) -> TagsDeleteResponse

🔌 Usage

client.tags().delete(
    TagDeleteRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .tagId("tagId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

tagId: String

client.tags.update(landscapeId, versionId, tagId, request) -> TagsUpdateResponse

🔌 Usage

client.tags().update(
    TagUpdateRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .tagId("tagId")
        .body(
            TagPartial
                .builder()
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

tagId: String

request: TagPartial

Teams

client.teams.list(organizationId) -> TeamsListResponse

🔌 Usage

client.teams().list(
    TeamsListRequest
        .builder()
        .organizationId("organizationId")
        .build()
);

⚙️ Parameters

organizationId: String

client.teams.create(organizationId, request) -> TeamsCreateResponse

🔌 Usage

client.teams().create(
    TeamCreateRequest
        .builder()
        .organizationId("organizationId")
        .body(
            TeamRequired
                .builder()
                .name("name")
                .build()
        )
        .build()
);

⚙️ Parameters

organizationId: String

request: TeamRequired

client.teams.get(organizationId, teamId) -> TeamsGetResponse

🔌 Usage

client.teams().get(
    TeamFindRequest
        .builder()
        .organizationId("organizationId")
        .teamId("teamId")
        .build()
);

⚙️ Parameters

organizationId: String

teamId: String

client.teams.delete(organizationId, teamId) -> Map&lt;String, Object&gt;

🔌 Usage

client.teams().delete(
    TeamDeleteRequest
        .builder()
        .organizationId("organizationId")
        .teamId("teamId")
        .build()
);

⚙️ Parameters

organizationId: String

teamId: String

client.teams.update(organizationId, teamId, request) -> TeamsUpdateResponse

🔌 Usage

client.teams().update(
    TeamUpdateRequest
        .builder()
        .organizationId("organizationId")
        .teamId("teamId")
        .body(
            TeamPartial
                .builder()
                .build()
        )
        .build()
);

⚙️ Parameters

organizationId: String

teamId: String

request: TeamPartial

client.teams.listLandscapes(organizationId, teamId) -> TeamsListLandscapesResponse

🔌 Usage

client.teams().listLandscapes(
    TeamLandscapesListRequest
        .builder()
        .organizationId("organizationId")
        .teamId("teamId")
        .build()
);

⚙️ Parameters

organizationId: String

teamId: String

client.teams.listModelObjects(organizationId, teamId) -> TeamsListModelObjectsResponse

🔌 Usage

client.teams().listModelObjects(
    TeamModelObjectsListRequest
        .builder()
        .organizationId("organizationId")
        .teamId("teamId")
        .build()
);

⚙️ Parameters

organizationId: String

teamId: String

Versions

client.versions.list(landscapeId) -> VersionsListResponse

🔌 Usage

client.versions().list(
    VersionsListRequest
        .builder()
        .landscapeId("landscapeId")
        .build()
);

⚙️ Parameters

landscapeId: String

client.versions.create(landscapeId, request) -> VersionsCreateResponse

🔌 Usage

client.versions().create(
    VersionCreateRequest
        .builder()
        .landscapeId("landscapeId")
        .body(
            VersionRequired
                .builder()
                .name("name")
                .notes("notes")
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

request: VersionRequired

client.versions.get(landscapeId, versionId) -> VersionsGetResponse

🔌 Usage

client.versions().get(
    VersionFindRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

client.versions.delete(landscapeId, versionId) -> Object

🔌 Usage

client.versions().delete(
    VersionDeleteRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

client.versions.update(landscapeId, versionId, request) -> VersionsUpdateResponse

🔌 Usage

client.versions().update(
    VersionUpdateRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .body(
            VersionPartial
                .builder()
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

request: VersionPartial

Catalog Technologies

client.catalog.technologies.createSignedIconUrl() -> TechnologiesCreateSignedIconUrlResponse

📝 Description

Create a signed URL prefix with access to all catalog icons

🔌 Usage

client.catalog().technologies().createSignedIconUrl();
client.catalog.technologies.get(catalogTechnologyId) -> TechnologiesGetResponse

📝 Description

Find a technology

🔌 Usage

client.catalog().technologies().get(
    CatalogTechnologyFindRequest
        .builder()
        .catalogTechnologyId("catalogTechnologyId")
        .build()
);

⚙️ Parameters

catalogTechnologyId: String

Comments Replies

client.comments.replies.list(landscapeId, versionId, commentId) -> RepliesListResponse

📝 Description

List comment replies

🔌 Usage

client.comments().replies().list(
    CommentRepliesListRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .commentId("commentId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

commentId: String

client.comments.replies.create(landscapeId, versionId, commentId, request) -> RepliesCreateResponse

📝 Description

Create a comment reply

🔌 Usage

client.comments().replies().create(
    CommentReplyCreateRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .commentId("commentId")
        .body(
            CommentReplyRequired
                .builder()
                .content("content")
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

commentId: String

request: CommentReplyRequired

client.comments.replies.get(landscapeId, versionId, commentId, commentReplyId) -> RepliesGetResponse

📝 Description

Find a comment reply

🔌 Usage

client.comments().replies().get(
    CommentReplyFindRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .commentId("commentId")
        .commentReplyId("commentReplyId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

commentId: String

commentReplyId: String

client.comments.replies.upsert(landscapeId, versionId, commentId, commentReplyId, request) -> RepliesUpsertResponse

🔌 Usage

client.comments().replies().upsert(
    CommentReplyUpsertRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .commentId("commentId")
        .commentReplyId("commentReplyId")
        .body(
            CommentReplyUpsert
                .builder()
                .content("content")
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

commentId: String

commentReplyId: String

request: CommentReplyUpsert

client.comments.replies.delete(landscapeId, versionId, commentId, commentReplyId) -> Map&lt;String, Object&gt;

📝 Description

Delete a comment reply

🔌 Usage

client.comments().replies().delete(
    CommentReplyDeleteRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .commentId("commentId")
        .commentReplyId("commentReplyId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

commentId: String

commentReplyId: String

client.comments.replies.update(landscapeId, versionId, commentId, commentReplyId, request) -> RepliesUpdateResponse

📝 Description

Update a comment reply

🔌 Usage

client.comments().replies().update(
    CommentReplyUpdateRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .commentId("commentId")
        .commentReplyId("commentReplyId")
        .body(
            CommentReplyPartial
                .builder()
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

commentId: String

commentReplyId: String

request: CommentReplyPartial

Diagrams Content

client.diagrams.content.get(landscapeId, versionId, diagramId) -> ContentGetResponse

🔌 Usage

client.diagrams().content().get(
    DiagramContentFindRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .diagramId("diagramId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

diagramId: String

updateViewedAt: Optional<Boolean>

client.diagrams.content.replace(landscapeId, versionId, diagramId, request) -> ContentReplaceResponse

🔌 Usage

client.diagrams().content().replace(
    DiagramContentReplaceRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .diagramId("diagramId")
        .body(
            DiagramContentRequired
                .builder()
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

diagramId: String

updateViewedAt: Optional<Boolean>

request: DiagramContentRequired

client.diagrams.content.update(landscapeId, versionId, diagramId, request) -> ContentUpdateResponse

🔌 Usage

client.diagrams().content().update(
    DiagramContentUpdateRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .diagramId("diagramId")
        .body(
            DiagramContentPartial
                .builder()
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

diagramId: String

updateViewedAt: Optional<Boolean>

request: DiagramContentPartial

Diagrams Groups

client.diagrams.groups.list(landscapeId, versionId) -> GroupsListResponse

🔌 Usage

client.diagrams().groups().list(
    DiagramGroupsListRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

filter: Optional<DiagramGroupFilter>

client.diagrams.groups.create(landscapeId, versionId, request) -> GroupsCreateResponse

🔌 Usage

client.diagrams().groups().create(
    DiagramGroupCreateRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .body(
            DiagramGroupRequired
                .builder()
                .modelId("modelId")
                .name("name")
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

request: DiagramGroupRequired

client.diagrams.groups.get(landscapeId, versionId, diagramGroupId) -> GroupsGetResponse

🔌 Usage

client.diagrams().groups().get(
    DiagramGroupFindRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .diagramGroupId("diagramGroupId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

diagramGroupId: String

client.diagrams.groups.upsert(landscapeId, versionId, diagramGroupId, request) -> GroupsUpsertResponse

🔌 Usage

client.diagrams().groups().upsert(
    DiagramGroupUpsertRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .diagramGroupId("diagramGroupId")
        .body(
            DiagramGroupUpsert
                .builder()
                .modelId("modelId")
                .name("name")
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

diagramGroupId: String

request: DiagramGroupUpsert

client.diagrams.groups.delete(landscapeId, versionId, diagramGroupId) -> GroupsDeleteResponse

🔌 Usage

client.diagrams().groups().delete(
    DiagramGroupDeleteRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .diagramGroupId("diagramGroupId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

diagramGroupId: String

client.diagrams.groups.update(landscapeId, versionId, diagramGroupId, request) -> GroupsUpdateResponse

🔌 Usage

client.diagrams().groups().update(
    DiagramGroupUpdateRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .diagramGroupId("diagramGroupId")
        .body(
            DiagramGroupPartial
                .builder()
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

diagramGroupId: String

request: DiagramGroupPartial

client.diagrams.groups.exists(landscapeId, versionId, diagramGroupId)

🔌 Usage

client.diagrams().groups().exists(
    DiagramGroupExistsRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .diagramGroupId("diagramGroupId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

diagramGroupId: String

Diagrams Export

client.diagrams.export.get(landscapeId, versionId, diagramId, diagramExportImageId) -> ExportGetResponse

🔌 Usage

client.diagrams().export().get(
    DiagramExportImageFindRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .diagramId("diagramId")
        .diagramExportImageId("diagramExportImageId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

diagramId: String

diagramExportImageId: String

client.diagrams.export.create(landscapeId, versionId, diagramId, request) -> ExportCreateResponse

🔌 Usage

client.diagrams().export().create(
    DiagramExportImageCreateRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .diagramId("diagramId")
        .body(
            DiagramExportImageOptions
                .builder()
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

diagramId: String

request: DiagramExportImageOptions

Flows Export

client.flows.export.text(landscapeId, versionId, flowId) -> String

🔌 Usage

client.flows().export().text(
    FlowExportTextRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .flowId("flowId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

flowId: String

client.flows.export.code(landscapeId, versionId, flowId) -> String

🔌 Usage

client.flows().export().code(
    FlowExportCodeRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .flowId("flowId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

flowId: String

client.flows.export.mermaid(landscapeId, versionId, flowId) -> String

🔌 Usage

client.flows().export().mermaid(
    FlowExportMermaidRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .flowId("flowId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

flowId: String

Landscapes Logs

client.landscapes.logs.list(landscapeId) -> LogsListResponse

📝 Description

List action logs

🔌 Usage

client.landscapes().logs().list(
    ActionLogsListRequest
        .builder()
        .landscapeId("landscapeId")
        .build()
);

⚙️ Parameters

landscapeId: String

filter: Optional<ActionLogFilter>

client.landscapes.logs.get(landscapeId, actionLogId) -> LogsGetResponse

📝 Description

Find an action log

🔌 Usage

client.landscapes().logs().get(
    ActionLogFindRequest
        .builder()
        .landscapeId("landscapeId")
        .actionLogId("actionLogId")
        .build()
);

⚙️ Parameters

landscapeId: String

actionLogId: String

client.landscapes.logs.listChildren(landscapeId, actionLogId) -> LogsListChildrenResponse

📝 Description

List actions that happened as a result of a different action

🔌 Usage

client.landscapes().logs().listChildren(
    ActionLogChildrenListRequest
        .builder()
        .landscapeId("landscapeId")
        .actionLogId("actionLogId")
        .build()
);

⚙️ Parameters

landscapeId: String

actionLogId: String

filter: Optional<ActionLogFilter>

Landscapes Export

client.landscapes.export.create(landscapeId, versionId, request) -> ExportCreateResponse

🔌 Usage

client.landscapes().export().create(
    LandscapeExportRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .type(LandscapeExportType.PDF)
        .body(
            LandscapeExportOptions
                .builder()
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

type: LandscapeExportType

filter: Optional<LandscapeExportFilter>

request: LandscapeExportOptions

client.landscapes.export.get(landscapeId, versionId, landscapeExportId) -> ExportGetResponse

🔌 Usage

client.landscapes().export().get(
    LandscapeExportFindRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .landscapeExportId("landscapeExportId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

landscapeExportId: String

Landscapes Logs Stats

client.landscapes.logs.stats.byType(landscapeId) -> ActionLogStatsListByType

📝 Description

List total counts of actions for each action type (e.g. diagram-content-update, model-object-create)

🔌 Usage

client.landscapes().logs().stats().byType(
    ActionLogStatsByTypeRequest
        .builder()
        .landscapeId("landscapeId")
        .build()
);

⚙️ Parameters

landscapeId: String

filter: Optional<ActionLogStatsFilter>

period: Optional<ActionLogStatsPeriod>

client.landscapes.logs.stats.byEntity(landscapeId) -> ActionLogStatsListByEntity

📝 Description

List total counts of actions for each entity identifier

🔌 Usage

client.landscapes().logs().stats().byEntity(
    ActionLogStatsByEntityRequest
        .builder()
        .landscapeId("landscapeId")
        .build()
);

⚙️ Parameters

landscapeId: String

filter: Optional<ActionLogStatsFilter>

period: Optional<ActionLogStatsPeriod>

Model Connections

client.model.connections.list(landscapeId, versionId) -> ConnectionsListResponse

🔌 Usage

client.model().connections().list(
    ModelConnectionsListRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

filter: Optional<ModelConnectionFilter>

expand: Optional<ModelConnectionExpandKey>

client.model.connections.create(landscapeId, versionId, request) -> ConnectionsCreateResponse

🔌 Usage

client.model().connections().create(
    ModelConnectionCreateRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .body(
            ModelConnectionRequired
                .builder()
                .name("name")
                .originId("originId")
                .targetId("targetId")
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

request: ModelConnectionRequired

client.model.connections.get(landscapeId, versionId, modelConnectionId) -> ConnectionsGetResponse

🔌 Usage

client.model().connections().get(
    ModelConnectionFindRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .modelConnectionId("modelConnectionId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

modelConnectionId: String

expand: Optional<ModelConnectionExpandKey>

client.model.connections.upsert(landscapeId, versionId, modelConnectionId, request) -> ConnectionsUpsertResponse

🔌 Usage

client.model().connections().upsert(
    ModelConnectionUpsertRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .modelConnectionId("modelConnectionId")
        .body(
            ModelConnectionUpsert
                .builder()
                .name("name")
                .originId("originId")
                .targetId("targetId")
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

modelConnectionId: String

originConnector: Optional<ConnectionsUpsertRequestOriginConnector>

targetConnector: Optional<ConnectionsUpsertRequestTargetConnector>

updateDiagrams: Optional<Boolean>

request: ModelConnectionUpsert

client.model.connections.delete(landscapeId, versionId, modelConnectionId) -> ConnectionsDeleteResponse

🔌 Usage

client.model().connections().delete(
    ModelConnectionDeleteRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .modelConnectionId("modelConnectionId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

modelConnectionId: String

client.model.connections.update(landscapeId, versionId, modelConnectionId, request) -> ConnectionsUpdateResponse

🔌 Usage

client.model().connections().update(
    ModelConnectionUpdateRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .modelConnectionId("modelConnectionId")
        .body(
            ModelConnectionPartial
                .builder()
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

modelConnectionId: String

updateDiagrams: Optional<Boolean>

request: ModelConnectionPartial

client.model.connections.generateDescription(landscapeId, versionId, modelConnectionId, request) -> ConnectionsGenerateDescriptionResponse

📝 Description

Generate a description for a model connection

🔌 Usage

client.model().connections().generateDescription(
    ModelConnectionGenerateDescriptionRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .modelConnectionId("modelConnectionId")
        .type(AiDescriptionType.CAPTION)
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

modelConnectionId: String

type: AiDescriptionType — Type of description to generate: "caption" for a short caption(50-70 characters), or "detailed" for a detailed description (max 2000 characters)

Model Objects

client.model.objects.list(landscapeId, versionId) -> ObjectsListResponse

🔌 Usage

client.model().objects().list(
    ModelObjectsListRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

filter: Optional<ModelObjectFilter>

expand: Optional<ModelObjectExpandKey>

client.model.objects.create(landscapeId, versionId, request) -> ObjectsCreateResponse

🔌 Usage

client.model().objects().create(
    ModelObjectCreateRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .body(
            ModelObjectRequired
                .builder()
                .name("name")
                .type(ModelObjectType.ACTOR)
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

request: ModelObjectRequired

client.model.objects.get(landscapeId, versionId, modelObjectId) -> ObjectsGetResponse

🔌 Usage

client.model().objects().get(
    ModelObjectFindRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .modelObjectId("modelObjectId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

modelObjectId: String

expand: Optional<ModelObjectExpandKey>

client.model.objects.upsert(landscapeId, versionId, modelObjectId, request) -> ObjectsUpsertResponse

🔌 Usage

client.model().objects().upsert(
    ModelObjectUpsertRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .modelObjectId("modelObjectId")
        .body(
            ModelObjectUpsert
                .builder()
                .name("name")
                .type(ModelObjectType.ACTOR)
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

modelObjectId: String

request: ModelObjectUpsert

client.model.objects.delete(landscapeId, versionId, modelObjectId) -> ObjectsDeleteResponse

🔌 Usage

client.model().objects().delete(
    ModelObjectDeleteRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .modelObjectId("modelObjectId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

modelObjectId: String

client.model.objects.update(landscapeId, versionId, modelObjectId, request) -> ObjectsUpdateResponse

🔌 Usage

client.model().objects().update(
    ModelObjectUpdateRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .modelObjectId("modelObjectId")
        .body(
            ModelObjectPartial
                .builder()
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

modelObjectId: String

request: ModelObjectPartial

Model Connections Export

client.model.connections.export.csv(landscapeId, versionId) -> String

🔌 Usage

client.model().connections().export().csv(
    ModelConnectionsExportCsvRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

Model Objects Export

client.model.objects.export.dependenciesJson(landscapeId, versionId, modelObjectId) -> ModelObjectDependenciesExport

📝 Description

Export object dependencies as JSON

🔌 Usage

client.model().objects().export().dependenciesJson(
    ModelObjectDependenciesExportJsonRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .modelObjectId("modelObjectId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

modelObjectId: String

client.model.objects.export.csv(landscapeId, versionId) -> String

📝 Description

Export all model objects as CSV

🔌 Usage

client.model().objects().export().csv(
    ModelObjectsExportCsvRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

Organizations Landscapes

client.organizations.landscapes.list(organizationId) -> LandscapesListResponse

🔌 Usage

client.organizations().landscapes().list(
    OrganizationLandscapesListRequest
        .builder()
        .organizationId("organizationId")
        .build()
);

⚙️ Parameters

organizationId: String

client.organizations.landscapes.create(organizationId, request) -> LandscapesCreateResponse

🔌 Usage

client.organizations().landscapes().create(
    OrganizationLandscapeCreateRequest
        .builder()
        .organizationId("organizationId")
        .name("name")
        .build()
);

⚙️ Parameters

organizationId: String

templateId: Optional<String>

Organizations Logs

client.organizations.logs.list(organizationId) -> LogsListResponse

📝 Description

List organization logs (only available on the scale plan and above)

🔌 Usage

client.organizations().logs().list(
    OrganizationLogsListRequest
        .builder()
        .organizationId("organizationId")
        .build()
);

⚙️ Parameters

organizationId: String

filter: Optional<OrganizationLogFilter>

client.organizations.logs.get(organizationId, organizationLogId) -> LogsGetResponse

📝 Description

Find an organization log (only available on the scale plan and above)

🔌 Usage

client.organizations().logs().get(
    OrganizationLogFindRequest
        .builder()
        .organizationId("organizationId")
        .organizationLogId("organizationLogId")
        .build()
);

⚙️ Parameters

organizationId: String

organizationLogId: String

Organizations Technologies

client.organizations.technologies.list(organizationId) -> TechnologiesListResponse

🔌 Usage

client.organizations().technologies().list(
    OrganizationTechnologiesListRequest
        .builder()
        .organizationId("organizationId")
        .build()
);

⚙️ Parameters

organizationId: String

filter: Optional<CatalogTechnologyFilter>

client.organizations.technologies.create(organizationId, request) -> TechnologiesCreateResponse

🔌 Usage

client.organizations().technologies().create(
    OrganizationTechnologyCreateRequest
        .builder()
        .organizationId("organizationId")
        .body(
            CatalogTechnologyRequired
                .builder()
                .color(TagColor.BLUE)
                .name("name")
                .build()
        )
        .build()
);

⚙️ Parameters

organizationId: String

request: CatalogTechnologyRequired

client.organizations.technologies.get(organizationId, catalogTechnologyId) -> TechnologiesGetResponse

🔌 Usage

client.organizations().technologies().get(
    OrganizationTechnologyFindRequest
        .builder()
        .organizationId("organizationId")
        .catalogTechnologyId("catalogTechnologyId")
        .build()
);

⚙️ Parameters

organizationId: String

catalogTechnologyId: String

client.organizations.technologies.delete(organizationId, catalogTechnologyId) -> Map&lt;String, Object&gt;

🔌 Usage

client.organizations().technologies().delete(
    OrganizationTechnologyDeleteRequest
        .builder()
        .organizationId("organizationId")
        .catalogTechnologyId("catalogTechnologyId")
        .build()
);

⚙️ Parameters

organizationId: String

catalogTechnologyId: String

client.organizations.technologies.update(organizationId, catalogTechnologyId, request) -> TechnologiesUpdateResponse

🔌 Usage

client.organizations().technologies().update(
    OrganizationTechnologyUpdateRequest
        .builder()
        .organizationId("organizationId")
        .catalogTechnologyId("catalogTechnologyId")
        .body(
            CatalogTechnologyPartial
                .builder()
                .build()
        )
        .build()
);

⚙️ Parameters

organizationId: String

catalogTechnologyId: String

request: CatalogTechnologyPartial

Organizations Users

client.organizations.users.list(organizationId) -> UsersListResponse

🔌 Usage

client.organizations().users().list(
    OrganizationUsersListRequest
        .builder()
        .organizationId("organizationId")
        .build()
);

⚙️ Parameters

organizationId: String

client.organizations.users.delete(organizationId, userId) -> Map&lt;String, Object&gt;

🔌 Usage

client.organizations().users().delete(
    OrganizationUserDeleteRequest
        .builder()
        .organizationId("organizationId")
        .userId("userId")
        .build()
);

⚙️ Parameters

organizationId: String

userId: String

client.organizations.users.update(organizationId, userId, request) -> UsersUpdateResponse

🔌 Usage

client.organizations().users().update(
    OrganizationUserUpdateRequest
        .builder()
        .organizationId("organizationId")
        .userId("userId")
        .body(
            OrganizationUser
                .builder()
                .permission(PermissionType.BILLING)
                .build()
        )
        .build()
);

⚙️ Parameters

organizationId: String

userId: String

request: OrganizationUser

Organizations Logs Stats

client.organizations.logs.stats.byType(organizationId) -> OrganizationLogStatsListByType

📝 Description

List total counts of actions for each action type (e.g. diagram-content-update, model-object-create)

🔌 Usage

client.organizations().logs().stats().byType(
    OrganizationLogStatsByTypeRequest
        .builder()
        .organizationId("organizationId")
        .build()
);

⚙️ Parameters

organizationId: String

filter: Optional<OrganizationLogStatsFilter>

period: Optional<ActionLogStatsPeriod>

client.organizations.logs.stats.byEntity(organizationId) -> ActionLogStatsListByEntity

📝 Description

List total counts of organizations for each entity identifier

🔌 Usage

client.organizations().logs().stats().byEntity(
    OrganizationLogStatsByEntityRequest
        .builder()
        .organizationId("organizationId")
        .build()
);

⚙️ Parameters

organizationId: String

filter: Optional<OrganizationLogStatsFilter>

period: Optional<ActionLogStatsPeriod>

Organizations Users Invites

client.organizations.users.invites.list(organizationId) -> InvitesListResponse

🔌 Usage

client.organizations().users().invites().list(
    OrganizationUserInvitesListRequest
        .builder()
        .organizationId("organizationId")
        .build()
);

⚙️ Parameters

organizationId: String

client.organizations.users.invites.create(organizationId, request) -> InvitesCreateResponse

🔌 Usage

client.organizations().users().invites().create(
    OrganizationUserInviteCreateRequest
        .builder()
        .organizationId("organizationId")
        .body(
            OrganizationUserInviteRequired
                .builder()
                .email("email")
                .expiresAt(OffsetDateTime.parse("2024-01-15T09:30:00Z"))
                .permission(PermissionType.BILLING)
                .build()
        )
        .build()
);

⚙️ Parameters

organizationId: String

request: OrganizationUserInviteRequired

client.organizations.users.invites.revoke(organizationId, organizationUserInviteId) -> InvitesRevokeResponse

🔌 Usage

client.organizations().users().invites().revoke(
    OrganizationUserInviteRevokeRequest
        .builder()
        .organizationId("organizationId")
        .organizationUserInviteId("organizationUserInviteId")
        .build()
);

⚙️ Parameters

organizationId: String

organizationUserInviteId: String

Tags Groups

client.tags.groups.list(landscapeId, versionId) -> GroupsListResponse

🔌 Usage

client.tags().groups().list(
    TagGroupsListRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

filter: Optional<TagGroupFilter>

client.tags.groups.create(landscapeId, versionId, request) -> GroupsCreateResponse

🔌 Usage

client.tags().groups().create(
    TagGroupCreateRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .body(
            TagGroupRequired
                .builder()
                .icon(TagGroupIcon.BUG)
                .index(1.1)
                .name("name")
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

request: TagGroupRequired

client.tags.groups.get(landscapeId, versionId, tagGroupId) -> GroupsGetResponse

🔌 Usage

client.tags().groups().get(
    TagGroupFindRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .tagGroupId("tagGroupId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

tagGroupId: String

client.tags.groups.upsert(landscapeId, versionId, tagGroupId, request) -> GroupsUpsertResponse

🔌 Usage

client.tags().groups().upsert(
    TagGroupUpsertRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .tagGroupId("tagGroupId")
        .body(
            TagGroupUpsert
                .builder()
                .icon(TagGroupIcon.BUG)
                .index(1.1)
                .name("name")
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

tagGroupId: String

request: TagGroupUpsert

client.tags.groups.delete(landscapeId, versionId, tagGroupId) -> GroupsDeleteResponse

🔌 Usage

client.tags().groups().delete(
    TagGroupDeleteRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .tagGroupId("tagGroupId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

tagGroupId: String

client.tags.groups.update(landscapeId, versionId, tagGroupId, request) -> GroupsUpdateResponse

🔌 Usage

client.tags().groups().update(
    TagGroupUpdateRequest
        .builder()
        .landscapeId("landscapeId")
        .versionId("versionId")
        .tagGroupId("tagGroupId")
        .body(
            TagGroupPartial
                .builder()
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionId: String

tagGroupId: String

request: TagGroupPartial

Versions Reverts

client.versions.reverts.list(landscapeId) -> RevertsListResponse

🔌 Usage

client.versions().reverts().list(
    VersionRevertsListRequest
        .builder()
        .landscapeId("landscapeId")
        .build()
);

⚙️ Parameters

landscapeId: String

client.versions.reverts.create(landscapeId, request) -> RevertsCreateResponse

🔌 Usage

client.versions().reverts().create(
    VersionRevertCreateRequest
        .builder()
        .landscapeId("landscapeId")
        .body(
            VersionRevertRequired
                .builder()
                .notes("notes")
                .versionId("versionId")
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

request: VersionRevertRequired

client.versions.reverts.get(landscapeId, versionRevertId) -> RevertsGetResponse

🔌 Usage

client.versions().reverts().get(
    VersionRevertFindRequest
        .builder()
        .landscapeId("landscapeId")
        .versionRevertId("versionRevertId")
        .build()
);

⚙️ Parameters

landscapeId: String

versionRevertId: String

client.versions.reverts.update(landscapeId, versionRevertId, request) -> RevertsUpdateResponse

🔌 Usage

client.versions().reverts().update(
    VersionRevertUpdateRequest
        .builder()
        .landscapeId("landscapeId")
        .versionRevertId("versionRevertId")
        .body(
            VersionRevertPartial
                .builder()
                .build()
        )
        .build()
);

⚙️ Parameters

landscapeId: String

versionRevertId: String

request: VersionRevertPartial