entwürfe/ {blueprint-id} /Aktivitäten/ {activity-id} /Dokumentation

Methodenübersicht

POST /bwl/blueprints/{blueprint-id}/activities/{activity-id}/documentation

Beschreibung

Mit diesem Verfahren können Sie die Dokumentation einer Aktivität in einem Blueprint aktualisieren.

Ressourceninformationen

Anforderungen	Beschreibung
Antwortformat	JSON
Erfordert Authentifizierung	Ja
Unterstützt OAuth 2-Clientberechtigungsnachweise	Ja, es wird eine Benutzer-Service-ID verwendet, die die Kategorie 'Artefaktauthoring' enthält.
Begrenzte Rate	IBM Blueworks Live wendet eine Ratenbegrenzung an, die bestimmt, wie oft diese API innerhalb eines bestimmten Zeitraums aufgerufen wird. Die zulässige Rate ist 200 Anforderungen pro Stunde. Die Ratenbegrenzung gilt für den gesamten Account. Auch wenn unterschiedliche Authentifizierungsmethoden verwendet werden, gilt die Rate für einen einzelnen Account für alle Benutzer. Wenn die Ratenbegrenzung für die API für das Konto überschritten wird, wird die nächste Anforderung mit dem Statuscode 429 und dem Antwortheader Retry-Afterabgelehnt, der die Anzahl der Sekunden angibt, die die nächste Anforderung erfolgen kann.

Parameter

Name	Standort	Beschreibung	Erforderlich	Typ
Content type	Header	Der Wert muss application/json sein.	Erforderlich, wenn Inhalt im Anforderungshauptteil enthalten ist.	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 Konto und im angegebenen Blueprint (falls vorhanden) verfügen.	Erforderlich, wenn OAuth-Berechtigungsnachweise für Service-ID verwendet werden. Nicht erforderlich, wenn der OAuth-Berechtigungsnachweis der Benutzerservice-ID verwendet wird.	Zeichenfolge
blueprint-id	Pfad	Die ID des Blueprints	Ja	Zeichenfolge
activity-id	Pfad	Die ID der Aktivität.	Ja	Zeichenfolge

JSON-Hauptteil der Anforderung

Der Anforderungshauptteil ist ein JSON-Objekt, das folgende Eigenschaften enthält:

Antwort

Beispiel-Dokumentation zur Aktualisierungsaktivität

• Benutzerservice-ID-OAuth 2-Clientberechtigungsnachweise verwenden:

  curl -i --request POST \
    --url https://yyour_server_url/bwl/blueprints/5f6000cc6003d/activities/5f6000cc60045/documentation \
    --header 'authorization: Bearer access_token' \
    --header 'content-type: application/json' \
    --data '{"description" : "<h1>New paragraph</h1>"}'

• OAuth 2-Clientberechtigungsnachweise für Service-ID verwenden:

  curl -i --request POST \
    --url https://your_server_url/bwl/blueprints/5f6000cc6003d/activities/5f6000cc60045/documentation \
    --header 'authorization: Bearer access_token' \
    --header 'X-On-Behalf-Of: user_name@domain.com' \
    --header 'content-type: application/json' \
    --data '{"description" : "<h1>New paragraph</h1>"}'

Beispielausgabe

Wenn die Anforderung erfolgreich ist, wird die Nachricht “200 OK” "Updated Activity Documentation" zurückgegeben.

Antwortheader

Headername	Beschreibung
Retry-After	Gibt an, wann die nächste Anforderung in Sekunden erfolgen kann.

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.
404	Die Blueprint-ID oder Aktivitäts-ID ist nicht vorhanden.
429	Die Anforderung hat die Ratenbegrenzung der API für diesen Account überschritten.

Weitere Informationen finden Sie unter OpenAPI Spezifikation.