Methods

General

This page lists all available API methods and describes their parameters and return values.

CopyWorkspace

This method requires an HTTP POST and copies an existing Workspace and all its contents to a newly created workspace. It has the following properties:

The call returns a SuccessStructure if everything worked as expected or an ExceptionStructure if an error occured.

Example

The following call copies the Workspace with ID aa6ffd4e-dc24-4ddb-8bb8-db494c31ea6f and gives the newly created workspace the name MyWorkspaceCopy:

Delete

This method requires an HTTP DELETE and deletes the entity with the given ID. It has the following parameters:

The call returns a SuccessStructure if everything worked as expected or an ExceptionStructure if an error occured.

Example

The following call deletes the entity with ID 3388b658-1baf-4058-abd1-44edecdad4c3:

ExecuteTask

This method requires an HTTP POST and executes the Task with a given ID. It has the following properties:

The call waits until the execution has finished and returns the ExecutionResultStructure.

Example

The following call executes the Task with ID 3388b658-1baf-4058-abd1-44edecdad4c3.

ExecuteTaskAsync

This method requires an HTTP POST and executes the Task with a given ID. It has the following properties:

The call immediately returns a GuidStructure that contains the ID of the request which can be used in a GetRequestExecutionStatus method to poll the status of the execution.

Example

The following call executes the Task with ID 3388b658-1baf-4058-abd1-44edecdad4c3.

GetAlert

This method requires an HTTP GET and returns the AlertStructure that represents the Alert with a given ID. It has the following properties:

The call returns the requested AlertStructure if everything worked as expected or an ExceptionStructure if an error occured.

Example

The following call returns an AlertStructure that represents the Alert with ID c81c3676-bc73-432b-b82e-a09b6b8d5777:

GetAlerts

This method requires an HTTP GET and returns an InteropStructureCollection that contains AlertStructures representing the queried Alerts. It has the following parameters:

The call returns an InteropStructureCollection containing the requested AlertStructures if everything worked as expected or an ExceptionStructure if an error occured.

Example

The following call returns an InteropStructureCollection containing AlertStructures of all Alerts that belong to the User with ID 24e68134-9e23-429e-9f46-30ca1921460c in the Workspace named MyWorkspace:

GetAuthenticatedUser

This method requires an HTTP GET and returns a UserStructure that represents the User that performs the API call. There are no parameters.

GetBackupConfiguration

This method requires an HTTP GET and returns the BackupConfigurationStructure that represents the current Backup Settings. The call returns the requested BackupConfigurationStructure if everything worked as expected or an ExceptionStructure if an error occured.

Example

The following call returns the BackupConfigurationStructure:

GetDataExchangeConfiguration

This method requires an HTTP GET and returns the DataExchangeConfigurationStructure that represents the current Data Exchange Settings. The call returns the requested DataExchangeConfigurationStructure if everything worked as expected or an ExceptionStructure if an error occured.

Example

The following call returns the DataExchangeConfigurationStructure:

GetDatasource

This method requires an HTTP GET and returns the DatasourceStructure that represents the Datasource with a given ID. It has the following properties:

The call returns the requested DatasourceStructure if everything worked as expected or an ExceptionStr**ucture if an error occured.

Example

The following call returns a DatasourceStructure that represents the Datasource with ID c81c3676-bc73-432b-b82e-a09b6b8d5777:

:::(Info)(GetDatasource API Call)
http(s)://<host>:<port>/Api/?Method=GetDatasource&Id=c81c3676-bc73-432b-b82e-a09b6b8d5777
:::

GetDatasources

This method requires an HTTP GET and returns an InteropStructureCollection that contains DatasourceStructures representing the queried Datasources. It has the following parameters:

The call returns an InteropStructureCollection containing the requested DatasourceStructures if everything worked as expected or an ExceptionStructure if an error occured.

Example

The following call returns an InteropStructureCollection containing DatasourceStructures of all Datasources that belong to the Workspace named MyWorkspace:

GetDeploymentConfiguration

This method requires an HTTP GET and returns the DeploymentConfigurationStructure that represents the current Deployment Settings. The call returns the requested DeploymentConfigurationStructure if everything worked as expected or an ExceptionStructure if an error occured.

Example

The following call returns the DeploymentConfigurationStructure:

GetEMailServers

This method requires an HTTP GET and returns an InteropStructureCollection that contains EMailServerStructures representing the queried E-Mail Servers. It has the following parameters:

The call returns an InteropStructureCollection containing the requested EMailServerStructures if everything worked as expected or an ExceptionStructure if an error occured.

Example

The following call returns an InteropStructureCollection containing EMailServerStructures of all E-Mail Servers whose name start with Def:

GetReport

This method requires an HTTP GET and returns the ReportStructure that represents the Report with a given ID. It has the following properties:

The call returns the requested ReportStructure if everything worked as expected or an ExceptionStructure if an error occured.

Example

The following call returns a ReportStructure that represents the Report with ID c81c3676-bc73-432b-b82e-a09b6b8d5777:

GetReports

This method requires an HTTP GET and returns an InteropStructureCollection that contains ReportStructures representing the queried Reports. It has the following parameters:

The call returns an InteropStructureCollection containing the requested ReportStructures if everything worked as expected or an ExceptionStructure if an error occured.

Example

The following call returns an InteropStructureCollection containing ReportStructures of all Reports that belong to the [Workspace](/release34/docs/workspaces named MyWorkspace:

GetReportSupportedFileTypes

This method requires an HTTP GET and returns an InteropStructureCollection that contains FileTypeStructures for all output file types supported by a Report with a given ID. It has the following parameters:

Example

The following call returns an InteropStructureCollection containing FileTypeStructures for supported output file types of the Report with ID c81c3676-bc73-432b-b82e-a09b6b8d5777:

GetSelfServiceReports

This method requires an HTTP GET and returns an InteropStructureCollection that contains ReportStructures representing Reports to which the User with the given ID has required Authorizations to request the report. It only returns reports within the Workspace with the given ID- It has the following parameters:

The call returns an InteropStructureCollection containing the requested ReportStructures if everything worked as expected or an ExceptionStructure if an error occured.

Example

The following call returns an InteropStructureCollection containing ReportStructures of all Reports that belong to the Workspace with ID f11f7c91-5c5d-4eb0-9a64-c34f04954615 for which the User with ID 4e4ff28a-d22e-4484-be08-4593875f17ff has required Authorizations to request the report:

GetTask

This method requires an HTTP GET and returns the TaskStructure that represents the Task with a given ID. It has the following properties:

The call returns the requested TaskStructure if everything worked as expected or an ExceptionStructure if an error occured.

Example

The following call returns a TaskStructure that represents the Task with ID* c81c3676-bc73-432b-b82e-a09b6b8d5777*:

GetTasks

This method requires an HTTP GET and returns an InteropStructureCollection that contains TaskStructures representing the queried Tasks. It has the following parameters:

The call returns an InteropStructureCollection containing the requested TaskStructures if everything worked as expected or an ExceptionStructure if an error occured.

Example

The following call returns an InteropStructureCollection containing TaskStructures of all Tasks that belong to the Workspace named MyWorkspace:

GetRequest

This method requires an HTTP GET and returns the RequestStructure with a given ID. It has the following properties:

The call returns the requested RequestStructure if everything worked as expected or an ExceptionStructure if an error occured.

Example

The following call returns a RequestStructure that represents the request with ID c81c3676-bc73-432b-b82e-a09b6b8d5777:

:::(Info)(GetRequest API Call)
http(s)://<host>:<port>/Api/?Method=GetRequest&Id=c81c3676-bc73-432b-b82e-a09b6b8d5777
:::

GetRequestExecutionStatus

This method requires an HTTP GET and returns the ExecutionStatusStructure for the request with a given ID. It has the following properties:

The call returns the requested ExecutionStatusStructure if everything worked as expected or an ExceptionStructure if an error occured.

Example

The following call returns a ExecutionStatusStructure of the request with ID c81c3676-bc73-432b-b82e-a09b6b8d5777:

GetUser

This method requires an HTTP GET and returns the UserStructure that represents the User with a given ID. It has the following properties:

The call returns the requested UserStructure if everything worked as expected or an ExceptionStructure if an error occured.

Example

The following call returns an UserStructure that represents the User with ID c81c3676-bc73-432b-b82e-a09b6b8d5777:

GetUsers

This method requires an HTTP GET and returns an InteropStructureCollection that contains UserStructures representing the queried Users. It has the following parameters:

The call returns an InteropStructureCollection containing the requested UserStructures if everything worked as expected or an ExceptionStructure if an error occured.

Example

The following call returns an InteropStructureCollection containing UserStructures of all Users with an e-mail address of user@company.com:

GetWorkspace

This method requires an HTTP GET and returns the WorkspaceStructure that represents the Workspace with a given ID. It has the following properties:

The call returns the requested WorkspaceStructure if everything worked as expected or an ExceptionStructure if an error occured.

Example

The following call returns an WorkspaceStructure that represents the Workspace with ID c81c3676-bc73-432b-b82e-a09b6b8d5777:

GetWorkspaces

This method requires an HTTP GET and returns an InteropStructureCollection that contains WorkspaceStructures representing the queried Workspaces. It has the following parameters:

The call returns an InteropStructureCollection containing the requested WorkspaceStructures if everything worked as expected or an ExceptionStructure if an error occured.

Example

The following call returns an InteropStructureCollection containing WorkspaceStructures of all Workspaces with a name that starts with R:

Persist

This method requires an HTTP POST and persists the InteropStructure supplied as POST data to the request. The call returns a SuccessStructure if everything worked as expected or an ExceptionStructure if an error occured.

RebuildDatasourceCache

This method requires an HTTP POST and rebuilds the cache of the Datasource with the given ID. It has the following parameters:

The call returns a SuccessStructure if everything worked as expected or an ExceptionStructure if an error occured.

Example

The following call rebuilds the cache of the Datasource with ID 3388b658-1baf-4058-abd1-44edecdad4c3: