Verify Interfaces de programación de aplicaciones (API)

Verify Se puede acceder a las interfaces de programación de aplicaciones (API) y utilizarlas para el desarrollo de aplicaciones internas.

Soporte Para obtener más información, consulta la documentación de la API en el IBM® Verify Centro de documentación.

Formación de IBM Mira un Verify vídeo sobre la API en la formación de IBM.

Métodos HTTP

Cada recurso de API se identifica por un identificador uniforme de recursos (URI) y se accede al mismo utilizando los siguientes métodos HTTP estándares. Los métodos HTTP indican la acción prevista sobre un objeto.
Tabla 1. HTTP métodos
Método HTTP Descripción
GET Recupera un recurso o una relación en el URL especificado.
  • Una solicitud en el recurso URL (<resource-noun>) recupera todas las instancias, sujetas a las restricciones de búsqueda y paginación (véase la sección de búsqueda).
  • Una solicitud a nivel de ID de recurso (<resource-noun>/<resource-id>) devuelve un recurso concreto.
  • Una consulta a nivel del nombre de la relación (<relationship>) recupera todas las instancias de la relación, sujetas a las restricciones de búsqueda y paginación.
  • El código de estado de respuesta predeterminado es 200.
  • La paginación del resultado se puede personalizar añadiendo un parámetro de consulta como "count" con un valor máximo de 1000.
  • Una consulta a nivel de ID de relación (<relationship>/<relationship-id>) devuelve una instancia de relación concreta.
POST Crea un recurso o una relación a nivel de URL especificado.
  • Una solicitud en el recurso URL crea el recurso.<resource-noun>
  • Una solicitud a nivel del ID de relación (<relationship>) crea la nueva relación.
  • Se puede utilizar para la creación de carga en bloque.
PUT Actualiza un recurso o una relación en el URL especificado.
  • Una solicitud en el recurso URL actualiza el recurso.<resource-noun>
  • Una solicitud a nivel del ID de relación (<relationship>) actualiza la nueva relación. No todas relaciones pueden modificarse, por lo que en algunos casos esto se puede considerar una solicitud errónea.
  • Una solicitud para cambiar información de solo lectura (como el identificador de recurso o de relación) se considera una solicitud errónea.
PATCH

Se utiliza para las actualizaciones parciales de un recurso.

  • Una solicitud a nivel del tipo de recurso « URL » (<resource-noun> solo actualiza los cambios de las propiedades que se incluyen en la solicitud del recurso especificado).
  • El tipo de contenido para PATCH es application/json-patch+json.
  • Si se especifica una operación de supresión con el identificador principal (ID exclusivo o propiedad que se correlaciona con una clave primaria), se suprime todo el objeto.
DELETE Elimina un recurso o una relación en el URL especificado.
Nota: Para la eliminación masiva, utiliza PATCH.