Function: getWorkspaces()
ts
function getWorkspaces(
client,
parameters?,
options?
): Promise<{
[key: string]: unknown;
workspaceIds: string[];
}>;Defined in: src/agile/api/operations.ts:82
Retrieve the either all Operations Workspace IDs associated with the Jira site or a specific Operations Workspace ID for the given ID.
The result will be what is currently stored, ignoring any pending updates or deletes.
E.g. GET /workspace?workspaceId=111-222-333
Only Connect apps that define the jiraOperationsInfoProvider module can access this resource. This resource requires the 'READ' scope for Connect apps.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters? | { workspaceId?: string; } | - |
parameters.workspaceId? | string | Optional Operations Workspace ID to retrieve a specific workspace. If omitted, all workspace IDs linked to the Jira site are returned. Example: workspaceId=111-222-333. |
options? | RequestOptions | - |
Returns
Promise<{ [key: string]: unknown; workspaceIds: string[]; }>