DocsOmniFi APIsChangelog
SkySparcContact UsLog In
OmniFi APIs

Create Workspace

api/autotest/workspaces

Creates a new Autotest workspace As specified by the supplied model.
A simple workspace can be created by specifying only Name and
StorageLocation, which are the only two mandatory properties.
Additional properties can be set as needed, including specifying
the full model detail.
The model can also be retrieved from an existing workspace and modified
with a unique Name and StorageLocation, and optionally additional modifications.
The source workspace then acts as a template for creating new workspaces.
Concurrency settings, stop conditions and result reporting extension
settings are copied from the template workspace. Any workspace variables
referenced from extension parameters (Variable or Expression) are
automatically created in the new workspace.

Body Params

Specification for the workspace.

Workspace is logical grouping of test cases, variables, logins and
other configuration. A Workspace contains one repository and multiple testplans.

int32

The workspace database ID. Omit or set this to 0 when creating
a new workspace.

string | null

The familiar name of the workspace. (Mandatory when creating a workspace).

string | null

The location of the workspace file storage. File storage is used
to store file collateral such as workbooks, and to store execution
log files. (Mandatory when creating a workspace).

boolean

Determines if result reporting is enabled or not.

boolean

Determines whether result reporting is run automatically after execution.

string | null

Gets or sets the ID of the result reporting extension.

ResultReportingParameters
array of objects | null

Gets or sets the result reporting parameters.

ResultReportingParameters
string | null

Gets or sets the user for authentication with the result reporting extension.

string | null

The password for authentication with the result reporting extension.
(WHen read, this is always null).

int32

Determines the max total concurrency setting for the workspace

int32

Determines the per-system concurrency setting for the workspace

int32

Determines the import concurrency setting for the workspace

DefaultErrorHandling
object | null

The default error handling per type of test plan node.
Valid values: (Stop|Continue).
The default error handling is Continue (ignore the error and
continue the execution). When creating a new workspace you can set
only the values that deviate from default.

LinkedVariables
object | null

A dictionary of variables that are linked to by result reporting
extension. The dictionary is keyed by variable Name.

DefaultMaxRetryCount
object | null

Gets or sets the default maximum retry count per GridItemType.
Keyed by the string value of GridItemType, with a nullable int value,
where null resolves to 0.
The default retry count is used when a task fails and doesn't have
a specific retry setting on it's own.
Retry is only applicable to tasks.

Headers
string
enum
Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json