Blueprint

Riepilogo del metodo

GET /blueprints

Descrizione

Utilizzare questo metodo per restituire un elenco di blueprint che soddisfano criteri specificati.

Informazioni risorsa

Requisiti	Descrizione
Formato della risposta	JSON
Richiede l'autenticazione	Vero
Supporta le credenziali client OAuth 2	Sì utilizzando un ID servizio utente contenente la categoria di creazione report di risorse utente

Parametri

Nome	Ubicazione	Descrizione	Obbligatorio	Tipo
X-IBM-API-Version	Intestazione	La versione di questa API. Quando si esegue una programmazione sull'API, è OBBLIGATORIO includere questa versione. In caso contrario viene utilizzata la versione più recente dell'API, che potrebbe però essere incompatibile con le versioni precedenti. Il valore corrente è 1.0.0.	No	Stringa
X-On-Behalf-Of	Intestazione	Il contesto utente. Il valore deve essere un nome utente nell'account. L'utente deve disporre dell'autorizzazione per eseguire l'azione nell'account e nello spazio parent specificato, se presente.	Richiesto se si utilizzano credenziali ID servizio OAuth. Non richiesto quando si utilizzano le credenziali dell'ID servizio utente OAuth.	Stringa
archived-state	Interroga	Filtra i risultati in base allo stato archiviato della risorsa utente. Se non specificato, viene utilizzato active . Gli unici valori consentiti sono active e archived.	No	Stringa
name	Interroga	Se specificato, vengono restituiti solo i blueprint con questo nome esatto. È necessario specificare un nome o una tag, ma non entrambi.	No	Stringa
space-id	Interroga	L'identificativo dello spazio in cui eseguire la ricerca. Se non specificato, la ricerca è estesa a tutto l'account. Se questo spazio contiene spazi child, verranno ricercati anche gli spazi child. Se vengono specificati sia l'id spazio che il nome spazio, l'id spazio ha la precedenza.	No	Stringa
space-name	Interroga	Il nome dello spazio in cui eseguire la ricerca. Se non specificato, la ricerca è estesa a tutto l'account. Se vengono specificati sia l'id spazio che il nome spazio, l'id spazio ha la precedenza.	No	Stringa
tag	Interroga	Se specificato, vengono restituiti solo i blueprint con questa tag esatta. È necessario specificare un nome o una tag, ma non entrambi.	No	Stringa

Risposta

Input di esempio

ELENCA tutti i blueprint denominati MyBlueprint all'interno dello spazio denominato MySpace, in un account a cui si ha accesso:

• Utilizzo dell'ID servizio utente OAuth 2 credenziali client:

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

• Utilizzo dell'ID servizio OAuth 2 credenziali client:

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

• Utilizzo dell'ID servizio OAuth 2 credenziali client con contesto utente:

  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"

Output di esempio

ELENCA tutti i blueprint denominati MyBlueprint all'interno dello spazio denominato MySpace, in un account a cui si ha accesso:

[
  {
    "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"
    }
  }
]

Messaggi di risposta

Codice HTTP	Motivo
200	La richiesta è stata completata correttamente.
400	Si è verificato un errore durante l'elaborazione della richiesta. I parametri richiesti non sono presenti o contengono valori non validi.
401	Questo utente non ha superato l'autenticazione. Questa risposta può essere restituita per i seguenti motivi: Sono stati forniti un nome utente o una password non validi. Questo utente appartiene a più account e un account non è stato specificato nella richiesta.
403	L'accesso è vietato. Questo messaggio può essere visualizzato per uno dei seguenti motivi: Le credenziali specificate non sono valide. Questo utente non è un editor per questo processo. Le API non sono abilitate dall'amministratore. Le API devono essere abilitate nella scheda Informazioni account . L'amministratore non ha accettato i termini e le condizioni del servizio.

Per ulteriori informazioni, consultare le specifiche di OpenAPI.