{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book Workspaces API", "version": "1.0.0" }, "items": [ { "info": { "name": "Workspaces", "type": "folder" }, "items": [ { "info": { "name": "List Workspaces", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workspaces", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "List workspaces in this organization. Only admin users of another organization (such as partners) may use this parameter." }, { "name": "locationId", "value": "YL34GrT...", "type": "query", "description": "Location associated with the workspace. Values must originate from the /locations API and not the legacy /workspaceLocations API." }, { "name": "workspaceLocationId", "value": "YL34GrT...", "type": "query", "description": "Location associated with the workspace. Both values from the /locations API and the legacy /workspaceLocations API are supported. This field is deprecated and integrations should prefer `locationId` going forward." }, { "name": "floorId", "value": "Y2lzY29z...", "type": "query", "description": "Floor associated with the workspace." }, { "name": "displayName", "value": "SFO-12 Capanina", "type": "query", "description": "List workspaces by display name." }, { "name": "capacity", "value": "5", "type": "query", "description": "List workspaces with the given capacity. Must be -1 or higher. A value of -1 lists workspaces with no capacity set." }, { "name": "type", "value": "focus", "type": "query", "description": "List workspaces by type." }, { "name": "start", "value": "50", "type": "query", "description": "Offset. Default is 0." }, { "name": "max", "value": "100", "type": "query", "description": "Limit the maximum number of workspaces in the response." }, { "name": "calling", "value": "freeCalling", "type": "query", "description": "List workspaces by calling type." }, { "name": "supportedDevices", "value": "collaborationDevices", "type": "query", "description": "List workspaces by supported devices." }, { "name": "calendar", "value": "none", "type": "query", "description": "List workspaces by calendar type." }, { "name": "deviceHostedMeetingsEnabled", "value": "true", "type": "query", "description": "List workspaces enabled for device hosted meetings." }, { "name": "devicePlatform", "value": "cisco", "type": "query", "description": "List workspaces by device platform." }, { "name": "healthLevel", "value": "error", "type": "query", "description": "List workspaces by health level." }, { "name": "includeDevices", "value": "false", "type": "query", "description": "Flag identifying whether to include the devices associated with the workspace in the response." }, { "name": "includeCapabilities", "value": "false", "type": "query", "description": "Flag identifying whether to include the workspace capabilities in the response." }, { "name": "plannedMaintenance", "value": "off", "type": "query", "description": "List workspaces with given maintenance mode." }, { "name": "customAttribute", "value": "myKey", "type": "query", "description": "List workspaces with given custom attribute key." } ] }, "docs": "List workspaces.\n\nUse query parameters to filter the response. The `orgId` parameter can only be used by admin users of another organization (such as partners). The `locationId`, `workspaceLocationId`, `indoorNavigation`, `floorId`, `capacity` and `type` fields will only be present for workspaces that have a value set for them. The special values `notSet` (for filtering on category) and `-1` (for filtering on capacity) can be used to filter for workspaces without a type and/or capacity." }, { "info": { "name": "Create a Workspace", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/workspaces", "body": { "type": "json", "data": "{}" } }, "docs": "Create a workspace.\n\nThe `locationId`, `workspaceLocationId`, `floorId`, `indoorNavigation`, `capacity`, `type`, `notes` and `hotdeskingStatus` parameters are optional, and omitting them will result in the creation of a workspace without these values set, or set to their default. A `locationId` must be provided when the `floorId` is set. Calendar and calling can also be set for a new workspace. Omitting them will default to free calling and no calendaring. The `orgId` parameter can only be used " }, { "info": { "name": "Get Workspace Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workspaces/:workspaceId", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc", "type": "path", "description": "A unique identifier for the workspace." }, { "name": "includeDevices", "value": "false", "type": "query", "description": "Flag identifying whether to include the devices associated with the workspace in the response." }, { "name": "includeCapabilities", "value": "false", "type": "query", "description": "Flag identifying whether to include the workspace capabilities in the response." } ] }, "docs": "Shows details for a workspace, by ID.\n\nThe `locationId`, `workspaceLocationId`, `floorId`, `indoorNavigation`, `capacity`, `type` and `notes` fields will only be present if they have been set for the workspace. Specify the workspace ID in the `workspaceId` parameter in the URI." }, { "info": { "name": "Update a Workspace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/workspaces/:workspaceId", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc", "type": "path", "description": "A unique identifier for the workspace." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates details for a workspace by ID.\n\nSpecify the workspace ID in the `workspaceId` parameter in the URI. Include all details for the workspace that are present in a [GET request for the workspace details](/docs/api/v1/workspaces/get-workspace-details). Not including the optional `capacity`, `type` or `notes` fields will result in the fields no longer being defined for the workspace. A `locationId` must be provided when the `floorId` is set. The `locationId`, `workspaceLocationId`, `floorId`, " }, { "info": { "name": "Delete a Workspace", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/workspaces/:workspaceId", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc", "type": "path", "description": "A unique identifier for the workspace." } ] }, "docs": "Deletes a workspace by ID.\n\nAlso deletes all devices associated with the workspace. Any deleted devices will need to be reactivated. Specify the workspace ID in the `workspaceId` parameter in the URI." }, { "info": { "name": "Get Workspace Capabilities", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workspaces/:workspaceId/capabilities", "params": [ { "name": "workspaceId", "value": "Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc", "type": "path", "description": "A unique identifier for the workspace." } ] }, "docs": "Shows the capabilities for a workspace by ID.\n\nReturns a set of capabilities, including whether or not the capability is supported by any device in the workspace, and if the capability is configured (enabled). For example for a specific capability like `occupancyDetection`, the API will return if the capability is supported and/or configured such that occupancy detection data will flow from the workspace (device) to the cloud. Specify the workspace ID in the `workspaceId` parameter in the URI." } ] } ], "bundled": true }