Create a Workspace
post
/api/restapi/workspace
Send a request to this endpoint to create a workspace.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : ApiEntityWorkspaceInput
Type:
object
Title:
ApiEntityWorkspaceInput
This entity represents a Workspace object, a unique Workspace object can be identified by the following combinations of the fields.
Show Source
- workspaceId
- workspaceCode,parentId
- workspaceCode,parentWorkspaceCode
-
description: string
Maximum Length:
4000
Summary of the workspace. -
image:imageRead Only:true
Deprecated. As of 23.11.An image associated with the workspace. -
isProduction: booleanRead Only:true
Deprecated. As of 23.11.Indicates a workspace that is in production.
All workspaces created under the Production workspace are automatically designated as production.
This cannot be changed. -
isSysGenerated: booleanRead Only:true
Deprecated. As of 23.11.Indicates a workspace that was created by the system.
System generated workspaces cannot be deleted. -
link: string(url)Read Only:true
Deprecated. As of 23.10.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
parentId(required): integer
(int64)
The unique identifier of the workspace hierarchically above another workspace.
-
parentWorkspaceCode: string
Minimum Length:
0
Maximum Length:60
The parent workspace code of a workspace. -
securityGuid: stringRead Only:true
Maximum Length:32
Deprecated. As of 23.11.The Globally Unique Identifier of the workspace. -
sequenceNumber: integer(int32)Read Only:true
Deprecated. As of 23.11.Determines the order of appearance of workspaces in a list. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated. -
workspaceAutonumSettings: arrayworkspaceAutonumSettingsRead Only:true
Deprecated. As of 23.11.An object containing workspace autonumber settings. -
workspaceCode(required): string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace. -
workspaceCurrencySetting:
workspaceCurrencySetting
Entity to create or update default currency and view the parent workspace currencies.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
-
workspaceName(required): string
Minimum Length:
1
Maximum Length:255
Name of a workspace. -
workspaceSettings: array
workspaceSettings
An object containing workspace settings.
Nested Schema : image
Read Only:
true
Deprecated. As of 23.11.An image associated with the workspace.
Match All
Show Source
-
object
ApiEntityWorkspaceImage
Title:
ApiEntityWorkspaceImage
Read Only:true
Nested Schema : workspaceAutonumSettings
Type:
array
Read Only:
true
Deprecated. As of 23.11.An object containing workspace autonumber settings.
Show Source
-
Array of:
object ApiEntityWorkspaceAutonumSettingInput
Title:
ApiEntityWorkspaceAutonumSettingInput
Read Only:true
Nested Schema : workspaceCurrencySetting
Entity to create or update default currency and view the parent workspace currencies.
Match All
Show Source
-
object
ApiEntityWorkspaceCurrencySettingInput
Title:
ApiEntityWorkspaceCurrencySettingInput
This entity represents a WorkspaceCurrencySetting object, a unique WorkspaceCurrencySetting object can be identified by the following combinations of the fields.- workspaceId
Nested Schema : workspaceSettings
Type:
array
An object containing workspace settings.
Show Source
-
Array of:
object ApiEntityWorkspaceSettingInput
Title:
ApiEntityWorkspaceSettingInput
Nested Schema : ApiEntityWorkspaceImage
Type:
object
Title:
ApiEntityWorkspaceImage
Read Only:
Show Source
true
-
image: array
image
An image object represented in binary format.
-
imageType: string
Allowed Values:
[ "PNG", "JPEG", "GIF" ]
The file type of the image. Valid values are PNG, JPEG, and GIF. -
link: string
(url)
Read Only:
true
The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
updateDate: string
(date-time)
Read Only:
true
Date when the record was last updated. -
workspaceId: integer
(int64)
The unique identifier of the workspace that contains this image.
-
workspaceImageId: integer
(int64)
The unique identifier of the image.
Nested Schema : ApiEntityWorkspaceAutonumSettingInput
Type:
object
Title:
ApiEntityWorkspaceAutonumSettingInput
Read Only:
Show Source
true
-
area: string
Allowed Values:
[ "IDEA", "PROGRAM", "PROJECT", "ACTIVITY", "SCHEDULE_SCENARIO", "ACTIVITY_ASSIGNMENT", "WBS", "SCOPE_ITEM", "SCOPE_ASSIGNMENT", "CHANGE_ITEM", "WORK_PACKAGE", "CHANGE_REQUEST", "CONTRACT", "COMMITMENT", "BUDGET_CHANGE", "BUDGET_TRANSFER", "PROGRAM_BUDGET", "PROGRAM_BUDGET_CHANGE", "PROGRAM_BUDGET_TRANSFER", "CHANGE_ORDER", "POTENTIAL_CHANGE_ORDER", "PAYMENT_APPLICATION", "RISK", "PROG_RISK", "ACTUALS", "WORK_MANAGER_TASK", "CONSTRAINT", "SUBMITTAL", "CHANGE_EVENT", "RFI", "CUSTOM_LOGS_ITEM", "RESOURCE" ]
Identifies the type of object used for auto numbering. -
autonumId: integer
(int64)
The unique identifier of an auto numbering sequence.
-
increment: integer
(int32)
Minimum Value:
1
Maximum Value:99999
Number by which the auto numbering suffix is incremented. -
link: string(url)Read Only:true
Deprecated. As of 23.10.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
name: string
Maximum Length:
50
Name of the auto numbering sequence. -
prefix: string
Minimum Length:
0
Maximum Length:20
Initial characters for the workspace auto numbering sequence. -
suffix: string
Minimum Length:
1
Maximum Length:20
The first number in the workspace auto numbering sequence. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated. -
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ApiEntityWorkspaceCurrencySettingInput
Type:
object
Title:
ApiEntityWorkspaceCurrencySettingInput
This entity represents a WorkspaceCurrencySetting object, a unique WorkspaceCurrencySetting object can be identified by the following combinations of the fields.
Show Source
- workspaceId
-
defaultCurrencyExchangeRate: numberRead Only:true
Deprecated. As of 23.11.The exchange rate of the workspace default currency. -
defaultCurrencyId: integer
(int64)
The workspace default currency that is selected on the workspace.
-
link: string(url)Read Only:true
Deprecated. As of 23.10.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated. -
workspaceCurrency1ExchangeRate: numberRead Only:true
Deprecated. As of 23.11.The exchange rate of the default currency of the first workspace in the hierarchy. -
workspaceCurrency1Id: integer(int64)Read Only:true
Deprecated. As of 23.11.The system-generated identifier of the default currency of the first workspace in the hierarchy. -
workspaceCurrency2ExchangeRate: numberRead Only:true
Deprecated. As of 23.11.The exchange rate of the default currency of the second workspace in the hierarchy. -
workspaceCurrency2Id: integer(int64)Read Only:true
Deprecated. As of 23.11.The system-generated identifier of the default currency of the second workspace in the hierarchy. -
workspaceCurrency3ExchangeRate: numberRead Only:true
Deprecated. As of 23.11.The exchange rate of the default currency of the third workspace in the hierarchy. -
workspaceCurrency3Id: integer(int64)Read Only:true
Deprecated. As of 23.11.The system-generated identifier of the default currency of the third workspace in the hierarchy. -
workspaceId: integer(int64)Read Only:true
Deprecated. As of 23.11.The unique identifier of a workspace.
Nested Schema : ApiEntityWorkspaceSettingInput
Type:
object
Title:
Show Source
ApiEntityWorkspaceSettingInput
-
link: string(url)Read Only:true
Deprecated. As of 23.10.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
settingName: string
Minimum Length:
0
Maximum Length:255
Name of a workspace setting. -
settingValue: string
Minimum Length:
0
Maximum Length:255
Value of a workspace setting. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated. -
workspaceId: integer(int64)Read Only:true
Deprecated. As of 23.11.The unique identifier of a workspace setting. -
workspaceSettingId: integer
(int64)
The unique identifier of a workspace setting.
Examples
Back to Top
Response
Supported Media Types
- application/json
201 Response
The object was successfully created.
Root Schema : ApiEntityWorkspace
Type:
object
Title:
Show Source
ApiEntityWorkspace
-
description: string
Maximum Length:
4000
Summary of the workspace. -
image:
image
An image associated with the workspace.
-
isProduction: boolean
Indicates a workspace that is in production.
All workspaces created under the Production workspace are automatically designated as production.
This cannot be changed. -
isSysGenerated: boolean
Indicates a workspace that was created by the system.
System generated workspaces cannot be deleted. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
parentId: integer
(int64)
The unique identifier of the workspace hierarchically above another workspace.
-
parentWorkspaceCode: string
Minimum Length:
0
Maximum Length:60
The parent workspace code of a workspace. -
securityGuid: string
Maximum Length:
32
The Globally Unique Identifier of the workspace. -
sequenceNumber: integer
(int32)
Determines the order of appearance of workspaces in a list.
-
updateDate: string
(date-time)
Date when the record was last updated.
-
workspaceAutonumSettings: array
workspaceAutonumSettings
An object containing workspace autonumber settings.
-
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace. -
workspaceCurrencySetting:
workspaceCurrencySetting
Entity to create or update default currency and view the parent workspace currencies.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
-
workspaceName: string
Minimum Length:
1
Maximum Length:255
Name of a workspace. -
workspaceSettings: array
workspaceSettings
An object containing workspace settings.
Nested Schema : image
An image associated with the workspace.
Match All
Show Source
-
object
ApiEntityWorkspaceImage
Title:
ApiEntityWorkspaceImage
Read Only:true
Nested Schema : workspaceAutonumSettings
Type:
array
An object containing workspace autonumber settings.
Show Source
-
Array of:
object ApiEntityWorkspaceAutonumSetting
Title:
ApiEntityWorkspaceAutonumSetting
Nested Schema : workspaceCurrencySetting
Entity to create or update default currency and view the parent workspace currencies.
Match All
Show Source
-
object
ApiEntityWorkspaceCurrencySetting
Title:
ApiEntityWorkspaceCurrencySetting
Nested Schema : workspaceSettings
Type:
array
An object containing workspace settings.
Show Source
-
Array of:
object ApiEntityWorkspaceSetting
Title:
ApiEntityWorkspaceSetting
Nested Schema : ApiEntityWorkspaceImage
Type:
object
Title:
ApiEntityWorkspaceImage
Read Only:
Show Source
true
-
image: array
image
An image object represented in binary format.
-
imageType: string
Allowed Values:
[ "PNG", "JPEG", "GIF" ]
The file type of the image. Valid values are PNG, JPEG, and GIF. -
link: string
(url)
Read Only:
true
The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
updateDate: string
(date-time)
Read Only:
true
Date when the record was last updated. -
workspaceId: integer
(int64)
The unique identifier of the workspace that contains this image.
-
workspaceImageId: integer
(int64)
The unique identifier of the image.
Nested Schema : ApiEntityWorkspaceAutonumSetting
Type:
object
Title:
Show Source
ApiEntityWorkspaceAutonumSetting
-
area: string
Allowed Values:
[ "IDEA", "PROGRAM", "PROJECT", "ACTIVITY", "SCHEDULE_SCENARIO", "ACTIVITY_ASSIGNMENT", "WBS", "SCOPE_ITEM", "SCOPE_ASSIGNMENT", "CHANGE_ITEM", "WORK_PACKAGE", "CHANGE_REQUEST", "CONTRACT", "COMMITMENT", "BUDGET_CHANGE", "BUDGET_TRANSFER", "PROGRAM_BUDGET", "PROGRAM_BUDGET_CHANGE", "PROGRAM_BUDGET_TRANSFER", "CHANGE_ORDER", "POTENTIAL_CHANGE_ORDER", "PAYMENT_APPLICATION", "RISK", "PROG_RISK", "ACTUALS", "WORK_MANAGER_TASK", "CONSTRAINT", "SUBMITTAL", "CHANGE_EVENT", "RFI", "CUSTOM_LOGS_ITEM", "RESOURCE" ]
Identifies the type of object used for auto numbering. -
autonumId: integer
(int64)
The unique identifier of an auto numbering sequence.
-
increment: integer
(int32)
Minimum Value:
1
Maximum Value:99999
Number by which the auto numbering suffix is incremented. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
name: string
Maximum Length:
50
Name of the auto numbering sequence. -
prefix: string
Minimum Length:
0
Maximum Length:20
Initial characters for the workspace auto numbering sequence. -
suffix: string
Minimum Length:
1
Maximum Length:20
The first number in the workspace auto numbering sequence. -
updateDate: string
(date-time)
Date when the record was last updated.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ApiEntityWorkspaceCurrencySetting
Type:
object
Title:
Show Source
ApiEntityWorkspaceCurrencySetting
-
defaultCurrencyExchangeRate: number
The exchange rate of the workspace default currency.
-
defaultCurrencyId: integer
(int64)
The workspace default currency that is selected on the workspace.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
updateDate: string
(date-time)
Date when the record was last updated.
-
workspaceCurrency1ExchangeRate: number
The exchange rate of the default currency of the first workspace in the hierarchy.
-
workspaceCurrency1Id: integer
(int64)
The system-generated identifier of the default currency of the first workspace in the hierarchy.
-
workspaceCurrency2ExchangeRate: number
The exchange rate of the default currency of the second workspace in the hierarchy.
-
workspaceCurrency2Id: integer
(int64)
The system-generated identifier of the default currency of the second workspace in the hierarchy.
-
workspaceCurrency3ExchangeRate: number
The exchange rate of the default currency of the third workspace in the hierarchy.
-
workspaceCurrency3Id: integer
(int64)
The system-generated identifier of the default currency of the third workspace in the hierarchy.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ApiEntityWorkspaceSetting
Type:
object
Title:
Show Source
ApiEntityWorkspaceSetting
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
settingName: string
Minimum Length:
0
Maximum Length:255
Name of a workspace setting. -
settingValue: string
Minimum Length:
0
Maximum Length:255
Value of a workspace setting. -
updateDate: string
(date-time)
Date when the record was last updated.
-
workspaceId: integer
(int64)
The unique identifier of a workspace setting.
-
workspaceSettingId: integer
(int64)
The unique identifier of a workspace setting.
400 Response
Invalid input.