Skip to content

Adds the standard Work Schedule section to a selected user menu.

POST
/api/workspace/admin/work-schedule/runtime-menu
curl --request POST \
--url https://example.com/api/workspace/admin/work-schedule/runtime-menu \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "RuntimeMenuId": "example" }'

The optional setup requires ready Operational Location, Worker, and Site definitions. Repeated calls reuse matching menu leaves.

access_token
string

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

Adds the standard Work Schedule section to a user menu.

object
RuntimeMenuId

Target user-menu identifier; null selects the preferred menu or creates the Default menu.

string
nullable
Examplegenerated
{
"RuntimeMenuId": "example"
}

OK

Media typeapplication/json
object
Data

Result of installing the standard Work Schedule section into a user menu.

object
RuntimeMenuId

Target user-menu identifier.

string
nullable
RuntimeMenuName

Target user-menu name.

string
nullable
CreatedRuntimeMenu

Whether the Default user menu was created.

boolean
CreatedItemCount

Number of new menu leaves.

integer format: int32
ReusedItemCount

Number of existing menu leaves reused without duplication.

integer format: int32
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

Result of installing the standard Work Schedule section into a user menu.

object
RuntimeMenuId

Target user-menu identifier.

string
nullable
RuntimeMenuName

Target user-menu name.

string
nullable
CreatedRuntimeMenu

Whether the Default user menu was created.

boolean
CreatedItemCount

Number of new menu leaves.

integer format: int32
ReusedItemCount

Number of existing menu leaves reused without duplication.

integer format: int32
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"
}

Not Found

Media typeapplication/json
object
Data

Result of installing the standard Work Schedule section into a user menu.

object
RuntimeMenuId

Target user-menu identifier.

string
nullable
RuntimeMenuName

Target user-menu name.

string
nullable
CreatedRuntimeMenu

Whether the Default user menu was created.

boolean
CreatedItemCount

Number of new menu leaves.

integer format: int32
ReusedItemCount

Number of existing menu leaves reused without duplication.

integer format: int32
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
}
]
}

Conflict

Media typeapplication/json
object
Data

Result of installing the standard Work Schedule section into a user menu.

object
RuntimeMenuId

Target user-menu identifier.

string
nullable
RuntimeMenuName

Target user-menu name.

string
nullable
CreatedRuntimeMenu

Whether the Default user menu was created.

boolean
CreatedItemCount

Number of new menu leaves.

integer format: int32
ReusedItemCount

Number of existing menu leaves reused without duplication.

integer format: int32
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
}
]
}