Workspaces

Os workspaces da organização — cada um com o seu portal, conectores, entidades e usuários do portal. O id ou o public_id de um workspace é o que vai no cabeçalho X-Workspace-Id (veja Autenticação). export baixa a configuração de um workspace como JSON, import create a restaura num workspace novo e usage conta o que a exclusão esconderia.

Comando	HTTP	Descrição
workspaces list	GET /v1/workspaces	Listar workspaces
workspaces create	POST /v1/workspaces	Criar workspace
workspaces get	GET /v1/workspaces/{id}	Consultar workspace
workspaces update	PATCH /v1/workspaces/{id}	Renomear workspace
workspaces delete	DELETE /v1/workspaces/{id}	Excluir workspace
workspaces export	GET /v1/workspaces/{id}/export	Exportar workspace
workspaces usage	GET /v1/workspaces/{id}/usage	Contar o que a exclusão do workspace esconderia
workspaces import create	POST /v1/workspaces/import	Importar workspace

Exemplos

--params carrega parâmetros de query, de caminho e de cabeçalho (id, página, filtros, X-Workspace-Id); --json carrega o corpo da requisição; --fields limita os campos que voltam — vale a pena em todo list/get, para economizar contexto. Veja Flags globais para a referência completa.

# Listar workspaces
kobana dashboards workspaces list --fields "id,public_id,name,role"

# Criar workspace
kobana dashboards workspaces create --json '{"name": "Portal de clientes"}'

# Renomear workspace
kobana dashboards workspaces update \
  --params '{"id": "WORKSPACE_ID"}' \
  --json '{"name": "Portal de parceiros"}'

# Exportar workspace
kobana dashboards workspaces export \
  --params '{"id": "WORKSPACE_ID"}' \
  --output workspace.json

# Contar o que a exclusão do workspace esconderia
kobana dashboards workspaces usage --params '{"id": "WORKSPACE_ID"}'

Próximos passos

• Membros
• Introspecção de schema — todos os parâmetros que este recurso aceita.