Jump to

• Request
• Response

Update a Workspace

put

/api/restapi/workspace

Send a request to this endpoint to update a workspace.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - 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.

• workspaceId
• workspaceCode,parentId
• workspaceCode,parentWorkspaceCode

Show Source

• 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.

{
    "title":"ApiEntityWorkspaceInput",
    "required":[
        "parentId",
        "workspaceCode",
        "workspaceName"
    ],
    "type":"object",
    "properties":{
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "description":{
            "maxLength":4000,
            "type":"string",
            "description":"Summary of the workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"Name of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The unique identifier of the workspace hierarchically above another workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "parentWorkspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The parent workspace code of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceSettings":{
            "type":"array",
            "description":"An object containing workspace settings.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityWorkspaceSettingInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "workspaceCurrencySetting":{
            "description":"Entity to create or update default currency and view the parent workspace currencies.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityWorkspaceCurrencySettingInput"
                }
            ]
        }
    },
    "description":"This entity represents a Workspace object, a unique Workspace object can be identified by the following combinations of the fields.<ul><li>workspaceId</li><li>workspaceCode,parentId</li><li>workspaceCode,parentWorkspaceCode</li>",
    "exampleSetFlag":false
}

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

{
    "description":"Entity to create or update default currency and view the parent workspace currencies.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityWorkspaceCurrencySettingInput"
        }
    ]
}

Nested Schema : workspaceSettings

Type: array

An object containing workspace settings.

Show Source

• Array of: object ApiEntityWorkspaceSettingInput
  Title: ApiEntityWorkspaceSettingInput

{
    "type":"array",
    "description":"An object containing workspace settings.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityWorkspaceSettingInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

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.

• workspaceId

Show Source

• defaultCurrencyId: integer (int64)
  The workspace default currency that is selected on the workspace.

{
    "title":"ApiEntityWorkspaceCurrencySettingInput",
    "type":"object",
    "properties":{
        "defaultCurrencyId":{
            "type":"integer",
            "description":"The workspace default currency that is selected on the workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "description":"This entity represents a WorkspaceCurrencySetting object, a unique WorkspaceCurrencySetting object can be identified by the following combinations of the fields.<ul><li>workspaceId</li>",
    "exampleSetFlag":false
}

Nested Schema : ApiEntityWorkspaceSettingInput

Type: object

Title: ApiEntityWorkspaceSettingInput

Show Source

• 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.

{
    "title":"ApiEntityWorkspaceSettingInput",
    "type":"object",
    "properties":{
        "settingName":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Name of a workspace setting.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "settingValue":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Value of a workspace setting.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceSettingId":{
            "type":"integer",
            "description":"The unique identifier of a workspace setting.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Update a Workspace Using Workspace ID

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

Invalid input.

Back to Top