Skip to main content
GET
Listar grupos de workspaces

Autorizaciones

Authorization
string
header
requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parámetros de ruta

organization_id
string
requerido

El identificador único de la organización

Maximum string length: 24
Pattern: ^[0-9a-f]{24}$

Parámetros de consulta

page
integer
predeterminado:1

Número de página (predeterminado: 1)

sort
string

Campo de ordenación con sufijo opcional de orden (:asc o :desc). Campos de ordenación válidos: id, name, description, create_user, create_date, type, location. El orden ascendente se usa por defecto si no se proporciona sufijo.

fields
string

Lista separada por comas de campos para incluir en cada elemento de grupos de workspaces. Campos seleccionables: id, name, description, organization_id, create_user, create_date, type, filter, location, entra_id_source. El campo id siempre se incluye.

Maximum string length: 2048
filters
string

Filtrar grupos de workspaces por uno o más criterios. Proporciona un objeto JSON con condiciones de filtrado. Puedes filtrar por: id, name, description, create_user, create_date, type, location, entra_id_source.resource_id, entra_id_source.resource_type, entra_id_source.resource_name. Para campos anidados como location o entra_id_source, usa notación por puntos (p. ej., location.latitude, entra_id_source.resource_type). Usa operadores de comparación (eq, ne, gt, gte, lt, lte, in, nin, contains, startsWith, endsWith, between) y combina múltiples condiciones con operadores lógicos (and, or). Longitud máxima: 5120 caracteres. Filtrar grupos de workspaces usando un objeto JSON. Especifica el campo a filtrar, el operador de comparación y el valor. Ejemplo: {"field": "name", "op": "eq", "value": "grupos de workspaces 1"}

Maximum string length: 5120
Ejemplo:

"{\"field\": \"name\", \"op\": \"eq\", \"value\": \"Grupo de Workspace 1\"}"

per_page
integer
predeterminado:100

Número de elementos por página

Rango requerido: 1 <= x <= 100

Respuesta

Lista paginada de grupos de workspaces recuperada correctamente. La respuesta incluye metadatos de paginación y un arreglo de datos de grupos de workspaces.

has_next
boolean
requerido
data
object[]
requerido