Skip to main content
GET
Listar grupos de espaços de trabalho

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

organization_id
string
obrigatório

O identificador único da organização

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

Parâmetros de consulta

page
integer
padrão:1

Número da página (padrão: 1)

sort
string

Campo de ordenação com sufixo opcional de ordem (:asc ou :desc). Campos de ordenação válidos: id, name, description, created_by, created_at, type, location. A ordem ascendente é usada por padrão se não houver sufixo.

fields
string

Lista separada por vírgulas de campos para incluir em cada elemento de grupos de workspaces. Campos selecionáveis: id, name, description, organization_id, created_by, created_at, type, filter, location, entra_id_source. O campo id sempre é incluído.

Maximum string length: 2048
filters
string

Filtrar grupos de workspaces por um ou mais critérios. Forneça um objeto JSON com condições de filtro. Pode-se filtrar por: id, name, description, created_by, created_at, type, location, entra_id_source.resource_id, entra_id_source.resource_type, entra_id_source.resource_name. Para campos aninhados como location ou entra_id_source, use notação de ponto (ex.: location.latitude, entra_id_source.resource_type). Use operadores de comparação (eq, ne, gt, gte, lt, lte, in, nin, contains, startsWith, endsWith, between) e combine múltiplas condições com operadores lógicos (and, or). Comprimento máximo: 5120 caracteres. Filtra grupos de workspaces usando um objeto JSON. Especifica o campo a filtrar, o operador de comparação e o valor. Exemplo: {"field": "name", "op": "eq", "value": "grupos de workspaces 1"}

Maximum string length: 5120
Exemplo:

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

per_page
integer
padrão:100

Número de itens por página

Intervalo obrigatório: 1 <= x <= 100

Resposta

Lista paginada de grupos de workspaces recuperada corretamente. A resposta inclui metadados de paginação e um conjunto de dados de grupos de workspaces.

has_next
boolean
obrigatório
data
object[]
obrigatório