Package com.structurizr.api

Class AdminApiClient

java.lang.Object

com.structurizr.api.AbstractApiClient

com.structurizr.api.AdminApiClient

public class AdminApiClient
extends AbstractApiClient

A client for the Structurizr Admin API.

Field Summary

Fields inherited from class com.structurizr.api.AbstractApiClient

agent, STRUCTURIZR_CLOUD_SERVICE_API_URL, STRUCTURIZR_FOR_JAVA_AGENT, url, VERSION, WORKSPACE_PATH

Constructor Summary

Constructors

Constructor	Description
AdminApiClient(String url, String username, String apiKey)	Creates a new admin API client.

Method Summary

Modifier and Type	Method	Description
WorkspaceMetadata	createWorkspace()	Creates a new workspace.
void	deleteWorkspace(int workspaceId)	Deletes a workspace.
List<WorkspaceMetadata>	getWorkspaces()	Gets a list of all workspaces.

Methods inherited from class com.structurizr.api.AbstractApiClient

getAgent, setAgent, setUrl

Methods inherited from class java.lang.Object

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

Constructor Details

AdminApiClient

public AdminApiClient(String url,
 String username,
 String apiKey)

Creates a new admin API client.

Parameters:

url - the URL of your Structurizr instance

username - the username (only required for the Structurizr cloud service)

apiKey - the API key of your workspace

Method Details

getWorkspaces

public List<WorkspaceMetadata> getWorkspaces()
                                      throws StructurizrClientException

Gets a list of all workspaces.

Returns:

a List of WorkspaceMetadata objects

Throws:

StructurizrClientException - if an error occurs

createWorkspace

public WorkspaceMetadata createWorkspace()
                                  throws StructurizrClientException

Creates a new workspace.

Returns:

a WorkspaceMetadata object representing the new workspace

Throws:

StructurizrClientException - if an error occurs

deleteWorkspace

public void deleteWorkspace(int workspaceId)
                     throws StructurizrClientException

Deletes a workspace.

Parameters:

workspaceId - the ID of the workspace to delete

Throws:

StructurizrClientException - if an error occurs