blueprints

Utilice este recurso para recuperar una lista de blueprints que cumplen los criterios especificados.

Resumen del método

Método HTTP	Vía de acceso	Descripción
GET	/bwl/blueprints	Devuelve una lista blueprints que cumplen los criterios especificados. Los criterios se expresan utilizando cero o más parámetros de filtro (`space-id`, `space-name`, `archived-state`) y un único parámetro de búsqueda (`name` o `tag`). Solo se devuelven los blueprints a los que se tiene acceso.

GET/blueprints

Descripción: Utilice este método para recuperar una lista de blueprints que cumplen los criterios especificados.

Información de recursos

Requisitos	Descripción
Formato de la respuesta	JSON
Requiere autenticación	Sí
Permite credenciales de cliente de OAuth 2	Sí, utilizando un ID de servicio de usuario que contiene la categoría de creación de informes de artefactos

Parámetros

Nombre	Ubicación	Descripción	Obligatorio	Tipo
X-IBM-API-Version	Cabecera	Versión de esta API. Si está programando contra la API, TIENE que incluir la versión. Si se omite, se usará la última versión de la API, que podría ser incompatible con versiones anteriores. El valor actual es `1.0.0`.	Nee	Serie
X-On-Behalf-Of	Cabecera	El contexto de usuario. El valor debe ser un nombre de usuario en la cuenta. El usuario debe tener permiso para realizar la acción en la cuenta y en el espacio padre especificado, si lo hay.	Necesario si se utilizan credenciales OAuth de ID de servicio. No es necesario cuando se utiliza la credencial OAuth de ID de servicio de usuario.	Serie
archived-state	Consulta	Filtra los resultados en función del estado archivado del artefacto. Si no se especifica se presupone `active`. Los únicos valores permitidos son `active` y `archived`.	Nee	Serie
name	Consulta	Si se especifica, solo se devolverán los blueprints que tengan este nombre exacto. Hay que especificar un nombre o una etiqueta, pero no ambos.	Nee	Serie
space-id	Consulta	Identificador del espacio en el que hay que buscar. Si no se especifica, la búsqueda se realiza en toda la cuenta. Si este espacio contiene espacios hijo, también se buscará en ellos. Si se especifican un space-id y un space-name, el space-id tendrá prioridad.	Nee	Serie
space-name	Consulta	Nombre del espacio en el que hay que buscar. Si no se especifica, la búsqueda se realiza en toda la cuenta. Si se especifican un space-id y un space-name, el space-id tendrá prioridad.	Nee	Serie
tag	Consulta	Si se especifica, solo se devolverán los blueprints que tengan exactamente esta etiqueta. Hay que especificar un nombre o una etiqueta, pero no ambos.	Nee	Serie

Respuesta

Entrada de ejemplo

Listar (con LIST) todos los blueprints llamados MyBlueprint en el espacio llamado MySpace en una cuenta a la que se tiene acceso:

Utilizando credenciales de cliente OAuth 2 de ID de servicio de usuario:

curl -i -H "Authorization: Bearer access_token" -H  
    "https://your_server_url/bwl/blueprints?space-name=MySpace&name=MyBlueprint"

Utilizando credenciales de cliente OAuth 2 de ID de servicio:

curl -i -H "Authorization: Bearer access_token" -H  
    "https://your_server_url/bwl/blueprints?space-name=MySpace&name=MyBlueprint"

Utilizando credenciales de cliente OAuth 2 de ID de servicio con contexto de usuario:

curl -i -H "Authorization: Bearer access_token" -H "X-On-Behalf-Of:user_name@domain.com" 
    "https://your_server_url/bwl/blueprints?space-name=MySpace&name=MyBlueprint"

Resultado de ejemplo

Listar (con LIST) todos los blueprints llamados MyBlueprint en el espacio llamado MySpace en una cuenta a la que se tiene acceso:

[
  {
    "id": "af0002",
    "name": "My Blueprint",
    "type": "blueprint",
    "space-ids": [
      "1310cb"
    ],
    "space-names": [
      "My Space"
    ],
    "archived-state": "active",
    "published-state": "unpublished",
    "last-modified-date": "2017-02-03T22:41:41.384+0000",
    "last-modified-by-user": {
      "id": "50029",
      "full-name": "Edith Editor",
      "email-address": "edith"
    },
    "created-date": "2017-02-01T22:41:41.260+0000",
    "created-by-user": {
      "id": "50029",
      "full-name": "Edith Editor",
      "email-address": "edith"
    }
  }
]

Mensajes de respuesta

Código HTTP	Razón
200	La solicitud se ha completado correctamente.
400	Hay un error al procesar la solicitud. Faltaban algunos parámetros obligatorios o contenían valores no válidos.
401	Este usuario no ha pasado la autenticación. Esta respuesta puede aparecer por las siguientes razones: Se ha proporcionado un nombre de usuario o contraseña no válidos. Este usuario pertenece a varias cuentas y no se ha especificado una cuenta en la solicitud.
403	El acceso está prohibido. Este mensaje puede aparecer por una de las razones siguientes: Las credenciales especificadas no son válidas. Este usuario no es un editor para este proceso. El administrador no ha habilitado las API. Las API se deben habilitar en la pestaña Información de la cuenta. El administrador no ha aceptado los Términos y condiciones del servicio.

Para más información, consulte OpenAPI specification.