Creates a workspace.
Try it now
Test
RAM authorization
Request syntax
POST HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| WorkspaceName |
string |
Yes |
The name of the workspace. |
test |
| WorkspaceDescription |
string |
No |
The description of the workspace. |
test |
| UseComment |
boolean |
No |
Specifies whether to use table remarks when you create a dataset in the workspace. Default value: true. |
true |
| AllowShare |
boolean |
No |
Specifies whether reports in the workspace can be shared. Default value: true. |
true |
| AllowPublish |
boolean |
No |
Specifies whether reports in the workspace can be made public. Default value: true. |
true |
| AllowViewAll |
boolean |
No |
Specifies whether the workspace is in collaboration mode. Default value: true. |
true |
| DefaultShareToAll |
boolean |
No |
Specifies whether to grant read permissions on the works in the workspace to all workspace members by default. Default value: false. |
false |
| OnlyAdminCreateDatasource |
boolean |
No |
Specifies whether only administrators can create data sources in the workspace. Default value: false. |
false |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
The request ID. |
685072****************4e79e718f |
| Result |
string |
The workspace ID. |
12423twfasva******** |
| Success |
boolean |
Indicates whether the request is successful. Valid values:
|
true |
Examples
Success response
JSON format
{
"RequestId": "685072****************4e79e718f",
"Result": "12423twfasva********",
"Success": true
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | Internal.System.Error | An internal system error occurred. | An internal system error occurred. |
| 400 | CreateWorkspace.Exceeds.Limits | The number of create workspace exceeds the maximum number limit:%s. | The number of create workspace exceeds the maximum number limit:%s. |
| 400 | UserRoleConfig.NotContain.Function | The user %s does not have permission to operate. | The user %s does not have permission to operate. |
| 400 | Duplicate.WorkSpaceName.Error | There is already a workspace with the same name %s, please rename it before saving. | |
| 400 | Transfer.Not.Allowed | Transfer to users with lower space permissions is not allowed. | Transfer to users with lower space permissions is not allowed. |
| 400 | Transfer.TargetUser.NotExist | The new owner does not exist. Please ensure that the target user has logged on to the system. | The new owner does not exist. Please ensure that the target user has logged on to the system. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.