beginWorkSession
Create/reuse a caller-bound work session. The explicit tabId is moved into its own new window when starting a session. create:false only looks up an existing session. Include returned workSessionId on subsequent actions.
API 2.3.3 · Published service contract ↗
Usage
Use the typed read or action tool permitted by the selected Pass documentation. Operation: beginWorkSession. A target tabId is required.
Use sym_pass_docs for the chosen Pass. Only its live supported operations and current capabilityRevision are callable.
Operation arguments
| Field | Type | Required | Description |
|---|---|---|---|
| sessionKey | string | ✓ | |
| create | boolean | × | |
| workSessionId | string | × |
{
"type": "object",
"properties": {
"sessionKey": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"create": {
"type": "boolean"
},
"workSessionId": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
},
"required": [
"sessionKey"
],
"additionalProperties": false
}Output
Output is operation- and device-dependent. Read the selected Pass’s current documentation and inspect the returned envelope.