É possível criar URIs REST para modificar registros no banco de dados do usuário estabelecendo link com os registros diretamente.
Sobre Esta Tarefa
Para criar um URI REST para modificar um registro:
Procedimento
- Na barra de ferramentas do Rational ClearQuest Web, clique na seta próxima ao Novo Pedido de Alteração e selecione Novo URI REST. O assistente Novo URI REST é aberto.
- Selecione Modificar um Registro na lista Tipo de URI REST.
- Selecione um tipo de registro na lista Tipo de Registro.
- Selecione uma ação na lista Tipo de Ação. Os tipos de ações disponíveis são determinados pelo tipo de registro.
- Opcional: selecione os campos de registro a serem incluídos como parâmetros no URI REST na lista Campos de registro a serem preenchidos automaticamente.
- Opcional: Para salvar todas as alterações no registro, selecione a caixa de opção Salvar Alterações
Automaticamente.
- Opcional: para incluir os parâmetros de login do Rational ClearQuest Web no URI REST, selecione Efetuar Login Automaticamente.
- Opcional: para incluir o banner, a árvore da área de trabalho e a barra de ferramentas principal na janela que é aberta quando o URI REST é executado, selecione a caixa de opção Incluir o banner, a árvore da área de trabalho e a barra de ferramentas principal.
- Clique em Criar. O modelo de URI REST é exibido no campo Modelo de URI REST.
- Copie o modelo em um editor de texto e substitua os sinalizadores de substituição, que estão entre chaves duplas {{ }}, pelos valores apropriados.
Opcional: altere o formato padrão do pedido de recurso de
HTML para XML ou ATOM.
- Copie o modelo modificado no aplicativo da Web ou em outra janela do navegador da Web.
- Clique em Reconfigurar para criar um novo modelo de URI REST ou em Fechar para sair.
Exemplo
Exemplos
O seguinte modelo de URI REST para modificar um registro foi criado usando o assistente Novo URI REST. Neste exemplo, ALMActivity foi selecionado na lista Tipo de Registro, Activate foi selecionado na lista Tipo de Ação e as caixas de opção Salvar Alterações Automaticamente, Efetuar Login Automaticamente e Incluir o banner, a árvores da área de trabalho e a barra de ferramentas principal foram selecionadas para criar o URI REST.
http://CQWebServerHost/cqweb/restapi/YourConnection/YourUserDB/RECORD?format=HTML&recordType=ALMActivity&action=Activate&fieldsXml=&autoSave=true&loginId={{loginid}}&password={{password}}
As variáveis e os sinalizadores de substituição de modelo têm os seguintes significados:
- CQWebServerHost
- Endereço da Web de seu sistema de host do servidor ClearQuest Web. Este valor é definido quando o modelo de URI REST é criado.
- YourConnection
- A conexão do usuário do ClearQuest. Este valor é definido quando o modelo de URI REST é criado.
- YourUserDB
- O banco de dados do usuário do ClearQuest. Este valor é definido quando o modelo de URI REST é criado.
- format
- O formato padrão do pedido de recurso é HTML.
É possível alterar o formato para XML ou ATOM, se desejado.
- {{loginid}}
- Sinalizador de substituição do ID de logon.
- {{password}}
- Sinalizador de substituição da senha.
Os seguintes exemplos mostram como inserir os valores do campo de data, do campo de referência, da lista de referência e do campo de múltiplas linhas como parâmetros em um URI REST.
- Este exemplo mostra como fornecer um valor do campo de data como um parâmetro em um URI REST para submeter ou modificar um registro:
fieldsXML=<Field><Name>f_datetime</Name><Value><![CDATA[2008-09-08%2009%3A44%3A34]]></Value></Field>
Resultado: o campo de registro f_datetime é configurado como 08/09/08
09:44:34.
- O exemplo a seguir mostra como fornecer valores de um campo de referência ou de uma lista de referência como parâmetros em um URI REST para submeter ou modificar um registro:
fieldsXML=<Field><Name>customer</Name><Value><!CDATA[Joe%20Lee]]></Value><Value><!CDATA[Jane%20Smith]]></Value></Field><Field><Name>Project</Name><Value><!CDATA[Classics]]></Value></Field>
Resultado: na lista de referência Cliente no registro, Joe
Lee e Jane Smith são incluídos, e no campo de referência Projeto, Classics é incluído.
- Este exemplo mostra como fornecer um valor do campo de múltiplas linhas como um parâmetro em um URI REST para submeter ou modificar um registro:
fieldsXML=<Field><Name>Description</Name><Value><![CDATA[firstline%0Asecondline]]></Value></Field>
Resultado: no campo de registro Descrição, os textos firstline e secondline são formatados para serem exibidos em linhas separadas.