Skip to content

Update local workspace display settings.

PUT
/api/workspace/admin/workspace-settings
curl --request PUT \
--url https://example.com/api/workspace/admin/workspace-settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "DisplayName": "example", "Locale": "example", "TimeZone": "example", "BusinessLogicAuthoringMode": "example", "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'
access_token
string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Request payload to update local workspace settings.

object
DisplayName

Workspace display name shown in the UI.

string
nullable
Locale

Workspace locale code.

string
nullable
TimeZone

Workspace IANA time zone identifier.

string
nullable
BusinessLogicAuthoringMode

Optional workspace business-logic authoring mode override.

string
nullable
RowVersion

Expected row version.

string format: uuid
Examplegenerated
{
"DisplayName": "example",
"Locale": "example",
"TimeZone": "example",
"BusinessLogicAuthoringMode": "example",
"RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

OK

Media typeapplication/json
object
Data

Local workspace settings that can be changed on-premises.

object
DisplayName

Workspace display name shown in the UI.

string
nullable
Locale

Workspace locale code.

string
nullable
TimeZone

Workspace IANA time zone identifier.

string
nullable
BusinessLogicAuthoringMode

Optional workspace business-logic authoring mode override.

string
nullable
RowVersion

Concurrency token.

string format: uuid
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Bad Request

Media typeapplication/json
object
Data

Local workspace settings that can be changed on-premises.

object
DisplayName

Workspace display name shown in the UI.

string
nullable
Locale

Workspace locale code.

string
nullable
TimeZone

Workspace IANA time zone identifier.

string
nullable
BusinessLogicAuthoringMode

Optional workspace business-logic authoring mode override.

string
nullable
RowVersion

Concurrency token.

string format: uuid
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Forbidden

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Conflict

Media typeapplication/json
object
Data

Local workspace settings that can be changed on-premises.

object
DisplayName

Workspace display name shown in the UI.

string
nullable
Locale

Workspace locale code.

string
nullable
TimeZone

Workspace IANA time zone identifier.

string
nullable
BusinessLogicAuthoringMode

Optional workspace business-logic authoring mode override.

string
nullable
RowVersion

Concurrency token.

string format: uuid
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}