Verify APIs (Application Programming Interfaces)

Verify As interfaces de programação de aplicativos (APIs) podem ser acessadas e utilizadas para o desenvolvimento de aplicativos internos.

Suporte Para obter mais informações, consulte a documentação da API no IBM® Verify Centro de Documentação.

Treinamento IBM Assista a um Verify vídeo sobre a API no curso de treinamen IBM.

Métodos de HTTP

Cada recurso da API é identificado por um Identificador Uniforme de Recursos (URI) nomeado e é acessado usando os seguintes métodos de HTTP padrão. Os métodos de HTTP indicam a ação desejada em um objeto.
Tabela 1. HTTP métodos
Método de HTTP Descrição
GET Recupera um recurso ou relacionamento na URL especificada.
  • Uma solicitação no recurso URL (<resource-noun>) recupera todas as instâncias, sujeitas às restrições de pesquisa e paginação (consulte a seção sobre pesquisa).
  • Uma solicitação no nível do ID do recurso (<resource-noun>/<resource-id>) retorna um recurso específico.
  • Uma consulta no nível do nome da relação (<relationship>) recupera todas as instâncias da relação, sujeitas às restrições de pesquisa e paginação.
  • O código de status de resposta padrão é 200.
  • A paginação para o resultado pode ser customizada incluindo um parâmetro de consulta como "count" com um valor máximo de 1000.
  • Uma consulta no nível do ID da relação (<relationship>/<relationship-id>) retorna uma instância específica da relação.
POST Cria um recurso ou relacionamento na URL especificada.
  • Uma solicitação no recurso URL cria o recurso.<resource-noun>
  • Uma solicitação no nível do ID da relação (<relationship>) cria a nova relação.
  • Pode ser usado para criação de carregamento em massa.
PUT Atualiza um recurso ou relacionamento na URL especificada
  • <resource-noun>Uma solicitação no recurso URL atualiza o recurso.
  • Uma solicitação no nível do ID da relação (<relationship>) atualiza a nova relação. Nem todos os relacionamentos podem ser modificados, portanto, em alguns casos, isso pode ser considerado uma solicitação inválida.
  • Uma solicitação para mudar informações somente leitura (como o identificador de recurso ou de relacionamento) é considerada uma solicitação inválida.
PATCH

Usado para atualizações parciais de um recurso.

  • Uma solicitação no nível do tipo de recurso URL atualiza apenas as diferenças das propriedades fornecidas na solicitação para o recurso especificado.<resource-noun>
  • O tipo de conteúdo para PATCH é application/json-patch+json.
  • Se uma operação de exclusão for especificada com o identificador principal (ID ou propriedade exclusiva que são mapeados para uma chave primária), o objeto inteiro será excluído.
EXCLUIR Remove um recurso ou relacionamento na URL especificada.
Observação: para exclusão em massa, use PATCH.