Batch Update Workspaces
put
/api/restapi/workspace/batch
Send a request to this endpoint to update one or more workspaces.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : List<ApiEntityWorkspaceInput>
Type:
array
Title:
Show Source
List<ApiEntityWorkspaceInput>
-
Array of:
object ApiEntityWorkspaceInput
Title:
ApiEntityWorkspaceInput
This entity represents a Workspace object, a unique Workspace object can be identified by the following combinations of the fields.- workspaceId
- workspaceCode,parentId
- workspaceCode,parentWorkspaceCode
Nested 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. -
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. -
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 : workspaceCurrencySetting
Entity to create or update default currency and view the parent workspace currencies.
Match All
Entity to create or update default currency and view the parent workspace currencies.
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 : 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
-
defaultCurrencyId: integer
(int64)
The workspace default currency that is selected on the workspace.
Nested Schema : ApiEntityWorkspaceSettingInput
Type:
object
Title:
Show Source
ApiEntityWorkspaceSettingInput
-
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. -
workspaceSettingId: integer
(int64)
The unique identifier of a workspace setting.
Examples
Back to Top
Response
200 Response
A collection of object IDs mapped to a canonical link of the object. For example - {"links":{"1":"https://[host]:[port]/api/restapi/[object]/1","2":"https://[host]:[port]/api/restapi/[object]/2"}}
400 Response
Invalid input.