Espaços do

Use este recurso para recuperar uma lista de espaços que atendem aos critérios especificados ou para criar um novo espaço.

Resumo do método

Método de HTTP Caminho Descrição
GET /bwl/spaces Retorna uma lista de espaços que atendam a critérios especificados. Os critérios são expressos usando zero ou mais parâmetros de filtro (archived-state, parent-space-id, parent-space-name, top-space-only) e exatamente um parâmetro de procura (name ou tag). Somente espaços aos quais você tiver acesso serão retornados.
POST /bwl/spaces Cria um espaço.

GET /spaces

Descrição
Use este método para retornar uma lista de espaços que atendam a critérios especificados.
Informações de recurso
Requisitos Descrição
Formato de resposta JSON
Requer autenticação True
Suporta credenciais do cliente OAuth 2 Sim usando um ID de Serviço do Usuário contendo Categoria de Autoria de Artefato
Parâmetros
Nome Local Descrição Necessário Tipo
X-IBM-API-Version Cabeçalho A versão dessa API. Se você estiver programando com relação à API, DEVERÁ incluir a versão. Se omitida, a versão mais recente da API será usada, que pode ser incompatível com versões anteriores.

O valor atual é 1.0.0.

 Não Sequência
X-On-Behalf-Of Cabeçalho O contexto do usuário. O valor deve ser um nome do usuário na conta. O usuário deve ter permissão para executar a ação na conta e no espaço pai especificado, se houver. Necessário se as credenciais de OAuth do ID de serviço forem usadas Não necessário ao usar a credencial OAuth do ID de Serviço do Usuário. Sequência
archived-state Consultar Filtra os resultados com base no estado arquivado do espaço. Se não especificado, active será assumido.

Os únicos valores permitidos são active e archived.

 Não Sequência
name Consultar Se especificado, somente espaços com esse nome exato serão retornados. Um nome ou uma tag devem ser especificados, mas não ambos. Não Sequência
parent-space-id Consultar O identificador do espaço no qual procurar. Se não especificado, a procura será contabilizada como ampla. Se esse espaço contiver espaços filhos, os espaços filhos também serão procurados. Se parent-space-id e parent-space-name estiverem especificados, parent-space-id terá precedência. Não Sequência
parent-space-name Consultar O nome do espaço no qual procurar. Se não especificado, a procura será contabilizada como ampla. Se parent-space-id e parent-space-name estiverem especificados, parent-space-id terá precedência. Não Sequência
tag Consultar Se especificado, somente espaços com essa tag exata serão retornados. Um nome ou uma tag devem ser especificados, mas não ambos. Não Sequência
top-space-only Consultar Se true, somente espaços de nível superior serão retornados. Espaços filhos não serão incluídos. Não Booleano
Resposta
Exemplo de entrada 1 - Criar um novo espaço
Crie um espaço com o nome "New Space".
  • Usando as credenciais do cliente OAuth 2 do ID de Serviço do Usuário:
    curl -i -H "Authorization: Bearer access_token"  
   -H "Content-Type:application/json" -X POST --data "{\"name\":\"New Space\"}" 
   "https://your_server_url/bwl/spaces"
  • Usando credenciais do cliente OAuth 2 do ID de serviço:
    curl -i -H "Authorization: Bearer access_token"  
   -H "Content-Type:application/json" -X POST --data "{\"name\":\"New Space\"}" "https://your_server_url/bwl/spaces"
  • Usando as credenciais do cliente OAuth 2 do ID de serviço com o contexto do usuário:
    curl -i -H "Authorization: Bearer access_token"  
   -H "Content-Type:application/json" -H "X-On-Behalf-Of:user_name@domain.com" 
   -X POST --data "{\"name\":\"New Space\"}" "https://your_server_url/bwl/spaces"
Exemplo de saída 1 - Criar um novo espaço
O novo espaço é criado e atribuído um ID.
{
"name": "New Space", "id" : "20012a"
}
Exemplo de entrada 2 - Criar um novo espaço como um filho de outro espaço
  • Usando as credenciais do cliente OAuth 2 do ID de Serviço do Usuário:
    curl -i -H "Authorization: Bearer access_token"  
   -H "Content-Type:application/json" -X POST --data "{\"name\":\"New Space\"}" 
   "https://your_server_url/bwl/spaces"
  • Usando credenciais do cliente OAuth 2 do ID de serviço:
    curl -i -H "Authorization: Bearer access_token"  
   -H "Content-Type:application/json" -X POST --data "{\"name\":\"New Space\"}" "https://your_server_url/bwl/spaces"
  • Usando as credenciais do cliente OAuth 2 do ID de serviço com o contexto do usuário:
    curl -i -H "Authorization: Bearer access_token"  
   -H "Content-Type:application/json" -H "X-On-Behalf-Of:user_name@domain.com" 
   -X POST --data "{\"name\":\"New Space\"}" "https://your_server_url/bwl/spaces"
Exemplo de saída 2 - Criar um novo espaço como um filho de outro espaço
O novo espaço filho é criado e um ID é designado a ele.
{
"name": "New Child Space", "id" : "20012b"
}
Propriedades de resposta
id
O ID do novo espaço.
name
O nome do novo espaço.
Cabeçalhos de resposta
Nome do Cabeçalho Descrição
Retry-After Quando a próxima solicitação pode ser feita, em número de segundos.
Mensagens de resposta
Código de HTTP Razão
200

A solicitação foi concluída com sucesso.
400

Há um erro ao processar a solicitação Os parâmetros necessários estavam ausentes ou continham valores inválidos.
401
A autenticação deste usuário não foi aprovada. Essa resposta poderá aparecer pelos seguintes motivos:
  • Um nome de usuário ou senha inválido fornecido.
  • Este usuário pertence a várias contas e uma conta não foi especificada na solicitação.
403
O acesso não é permitido. Esta mensagem pode aparecer por uma das seguintes razões:
  • As credenciais especificadas são inválidas.
  • Este usuário não é um editor para este processo.
  • As APIs não estão ativadas pelo administrador. As APIs devem ser ativadas na guia Dados da conta.
  • O administrador não aceitou os Termos e Condições de serviço.

POST /spaces

Descrição
Use este método para criar um espaço.
Informações de recurso
Requisitos Descrição
Formato de resposta JSON
Requer autenticação True
Suporta credenciais do cliente OAuth 2 Sim usando um ID de Serviço do Usuário contendo Categoria de Autoria de Artefato
Taxa limitada O IBM Blueworks Live aplica um limite de taxa que determina com que frequência essa API pode ser chamada em um período específico. A taxa permitida é de 500 solicitações por hora.

O limite de taxa é aplicado à conta inteira. Mesmo se métodos de autenticação diferentes forem usados, a taxa única de toda a conta será aplicada em todos os usuários.

Quando o limite de taxa para a API é excedido para a conta, a próxima solicitação é rejeitada com o código de status 429 e o cabeçalho de resposta Retry-After, que indica o número de segundos quando a próxima solicitação pode ser feita.
Parâmetros
Nome Local Descrição Necessário Tipo
Content-Type Cabeçalho O valor deve ser application/json. True Sequência
X-On-Behalf-Of Cabeçalho O contexto do usuário. O valor deve ser um nome do usuário na conta. O usuário deve ter permissão para criar um artefato na conta e o espaço pai especificado, se houver. Necessário se as credenciais de OAuth do ID de serviço forem usadas Não necessário ao usar a credencial OAuth do ID de Serviço do Usuário. Sequência
Corpo JSON da solicitação
O corpo da solicitação é um objeto JSON que contém as propriedades a seguir:
Nome Local Descrição Necessário Tipo
name Corpo de JSON O nome do novo espaço. True Sequência
parent-space-id Corpo de JSON O ID do espaço pai para o novo espaço. Não Sequência
Resposta
Exemplo de entrada 1 - Criar um novo espaço
Crie um espaço com o nome "New Space".
  • Usando as credenciais do cliente OAuth 2 do ID de Serviço do Usuário:
    curl -i -H "Authorization: Bearer access_token"  
   -H "Content-Type:application/json" -X POST --data "{\"name\":\"New Space\"}" 
   "https://your_server_url/bwl/spaces"
  • Usando credenciais do cliente OAuth 2 do ID de serviço:
    curl -i -H "Authorization: Bearer access_token"  
   -H "Content-Type:application/json" -X POST --data "{\"name\":\"New Space\"}" "https://your_server_url/bwl/spaces"
  • Usando as credenciais do cliente OAuth 2 do ID de serviço com o contexto do usuário:
    curl -i -H "Authorization: Bearer access_token"  
   -H "Content-Type:application/json" -H "X-On-Behalf-Of:user_name@domain.com" 
   -X POST --data "{\"name\":\"New Space\"}" "https://your_server_url/bwl/spaces"
Exemplo de saída 1 - Criar um novo espaço
O novo espaço é criado e atribuído um ID.
{
"name": "New Space", "id" : "20012a"
}
Exemplo de entrada 2 - Criar um novo espaço como um filho de outro espaço
  • Usando as credenciais do cliente OAuth 2 do ID de Serviço do Usuário:
    curl -i -H "Authorization: Bearer access_token"  
   -H "Content-Type:application/json" -X POST --data "{\"name\":\"New Space\"}" 
   "https://your_server_url/bwl/spaces"
  • Usando credenciais do cliente OAuth 2 do ID de serviço:
    curl -i -H "Authorization: Bearer access_token"  
   -H "Content-Type:application/json" -X POST --data "{\"name\":\"New Space\"}" "https://your_server_url/bwl/spaces"
  • Usando as credenciais do cliente OAuth 2 do ID de serviço com o contexto do usuário:
    curl -i -H "Authorization: Bearer access_token"  
   -H "Content-Type:application/json" -H "X-On-Behalf-Of:user_name@domain.com" 
   -X POST --data "{\"name\":\"New Space\"}" "https://your_server_url/bwl/spaces"
Exemplo de saída 2 - Criar um novo espaço como um filho de outro espaço
O novo espaço filho é criado e um ID é designado a ele.
{
"name": "New Child Space", "id" : "20012b"
}
Propriedades de resposta
id
O ID do novo espaço.
name
O nome do novo espaço.
Cabeçalhos de resposta
Nome do Cabeçalho Descrição
Retry-After Quando a próxima solicitação pode ser feita, em número de segundos.
Mensagens de resposta
Código de HTTP Razão
200

A solicitação foi concluída com sucesso.
400 Houve um erro ao processar a solicitação. Essa resposta poderá aparecer pelos seguintes motivos:
  • O corpo JSON está ausente da solicitação.
  • O ID do espaço pai fornecido não existe nesta conta.
  • A propriedade name está ausente do corpo da solicitação JSON.
401
A autenticação deste usuário não foi aprovada. Essa resposta poderá aparecer pelos seguintes motivos:
  • Um nome de usuário ou senha inválido fornecido.
  • Este usuário pertence a várias contas e uma conta não foi especificada na solicitação.
403 Esse usuário não tem permissão para criar um espaço nessa conta.

Para obter mais informações, consulte a especificação OpenAPI.