Entwürfe

Mit dieser Ressource können Sie eine Liste der Entwürfe abrufen, die bestimmte Kriterien erfüllen.

Hinweis: Die API-Dokumentation wurde zu IBM API Hub Externer Link öffnet ein neues Fenster oder einen neuen Tab

migriert. Die neuesten Updates und Dokumentationen für Blueworks Live APIs finden Sie im API Hub.

Methodenübersicht

HTTP-Methode	Pfad	Beschreibung
GET	/bwl/blueprints	Gibt eine Liste der Entwürfe zurück, die bestimmte Kriterien erfüllen. Die Kriterien werden mit keinem oder mehr Filterparametern (`space-id`, `space-name`, `archived-state`) und genau einem Suchparameter (`name` oder `tag`) ausgedrückt. Es werden nur Entwürfe zurückgegeben, auf die Sie Zugriff haben.

GET/blueprints

Beschreibung: Mit dieser Methode können Sie eine Liste der Entwürfe zurückgeben, die bestimmte Kriterien angegeben.

Ressourceninformationen

Anforderungen	Beschreibung
Antwortformat	JSON
Erfordert Authentifizierung	Ja
Unterstützt OAuth 2-Clientberechtigungsnachweise	Ja, es wird eine Benutzerservice-ID verwendet, die die Artefaktberichtskategorie enthält

Parameter

Name	Standort	Beschreibung	Erforderlich	Typ
X-IBM-API-Version	Header	Die Version dieser API. Bei der Programmierung mit der API MÜSSEN Sie die Version angeben. Erfolgt dies nicht, wird die aktuellste Version der API verwendet, die möglicherweise nicht mit früheren Versionen kompatibel ist. Der aktuelle Wert ist `1.0.0`.	Nein	Zeichenfolge
X-On-Behalf-Of	Header	Der Benutzerkontext. Der Wert muss ein Benutzername im Account sein. Der Benutzer muss über die Berechtigung zum Ausführen der Aktion im Account und im angegebenen übergeordneten Speicherbereich verfügen, sofern vorhanden.	Erforderlich, wenn Anmeldeinformationen für die Dienst-ID „ OAuth “ verwendet werden. Nicht erforderlich bei Verwendung der Anmeldeinformationen „User Service ID OAuth “.	Zeichenfolge
archived-state	Query	Filtert die Ergebnisse in Abhängigkeit vom Archivierungsstatus des Artefakts. Wenn nichts angegeben ist, wird `active` angenommen. Die einzigen zulässigen Werte sind `active` und `archived`.	Nein	Zeichenfolge
name	Query	Wird dieser Parameter angegeben, werden nur Werte mit genau diesem Namen zurückgegeben. Es muss entweder ein Name oder ein Tag, jedoch nicht beides angegeben werden.	Nein	Zeichenfolge
space-id	Query	Die ID des Speicherbereichs, in dem gesucht werden soll. Wird der Parameter nicht angegeben, wird eine accountweite Suche durchgeführt. Enthält dieser Speicherbereich untergeordnete Speicherbereiche, werden diese untergeordneten Speicherbereiche ebenfalls durchsucht. Werden Bereichs-ID und Bereichsname angegeben, hat die Bereichs-ID Vorrang.	Nein	Zeichenfolge
space-name	Query	Der Name des Speicherbereichs, in dem gesucht werden soll. Wird der Parameter nicht angegeben, wird eine accountweite Suche durchgeführt. Werden Bereichs-ID und Bereichsname angegeben, hat die Bereichs-ID Vorrang.	Nein	Zeichenfolge
tag	Query	Wird dieser Parameter angegeben, werden nur Entwürfe mit genau diesem Tag zurückgegeben. Es muss entweder ein Name oder ein Tag, jedoch nicht beides angegeben werden.	Nein	Zeichenfolge

Antwort

Beispieleingabe

Auflisten aller Entwürfe mit dem Namen "MyBlueprint" in dem Bereich "MySpace" in einem Account, auf den Sie zugreifen können:

Verwendung der Client-Anmeldeinformationen der Benutzer-Service-ID OAuth 2:

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

Verwendung der Client-Anmeldeinformationen „Service ID OAuth 2“:

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

Verwendung der Service-ID OAuth 2 Client-Anmeldeinformationen mit Benutzerkontext:

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"

Beispielausgabe

Auflisten aller Entwürfe mit dem Namen "MyBlueprint" in dem Bereich "MySpace" in einem Account, auf den Sie zugreifen können:

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

Antwortnachrichten

HTTP-Code	Grund
200	Die Anforderung wurde erfolgreich ausgeführt.
400	Bei der Verarbeitung der Anforderung ist ein Fehler aufgetreten. Erforderliche Parameter fehlten oder enthielten ungültige Werte.
401	Die Authentifizierung dieses Benutzers ist gescheitert. Für diese Antwort gibt es folgende Gründe: Ein ungültiger Benutzername oder ein ungültiges Kennwort wurde angegeben. Dieser Benutzer gehört mehreren Accounts an und in der Anforderung wurde kein Account angegeben.
403	Zugriff ist verboten. Die Ausgabe dieser Nachricht kann einen der folgenden Gründe haben: Die angegebenen Berechtigungsnachweise sind ungültig. Dieser Benutzer ist kein Bearbeiter dieses Prozesses. APIs sind vom Administrator nicht aktiviert. APIs müssen auf der Registerkarte Accountinformationen aktiviert werden. Der Administrator hat die Bedingungen dieses Service nicht akzeptiert.

Weitere Informationen finden Sie unter OpenAPI Spezifikation.