Zum Hauptinhalt springen

PUT /cards

Beschreibung

Aktualisiert Daten auf einer angegebenen Karte und gibt ein leeres JSON-Objekt zurück

Die Route verarbeitet die HTTP PUT-Anfrage, die an den Pfad /cards/{id} gesendet wird.

Pfadparameter

Der folgende Parameter wird in der Anforderungszeile übergeben:

NameTypBeschreibung
idnumberErforderlich. Die ID der zu aktualisierenden Karte.

Payload

Der Server muss ein JSON-Objekt erhalten, das das Kartenobjekt enthält und alle Eigenschaften der Karte umfasst (sowohl unveränderte als auch neue/geänderte).

NameTypBeschreibung
labelstringErforderlich. Der Name der zu aktualisierenden Karte.
descriptionstringErforderlich. Die Beschreibung der Karte.
columnnumberErforderlich. Die ID der Spalte, auf die sich die Karte bezieht.
rownumberErforderlich. Die ID der Zeile, auf die sich die Karte bezieht.
start_datestringErforderlich. Das Startdatum im ISO-Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX
end_datestringErforderlich. Das Enddatum im ISO-Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX
progressnumberErforderlich. Der Wert der Fortschrittsanzeige im Bereich von 0 bis 100 Punkten.
attachedobjectErforderlich. Ein Array mit Daten der angehängten Datei(en). Siehe das Objektbeispiel hier cards
colorstringErforderlich. Die Farbe der oberen Kartenlinie im HEX-Format.
prioritynumberErforderlich. Die Prioritäts-ID der Karte.
usersobjectErforderlich. Ein Array mit den IDs der zugewiesenen Benutzer. Siehe das Objektbeispiel hier cardShape

Beispiel:

{
"card": {
"label": "Drag and drop",
"description": "",
"column": 3,
"row": 1,
"start_date": null,
"end_date": "2018-01-01T00:00:00Z",
"progress": 100,
"attached": [],
"color": "#58C3FE",
"priority": 2,
"users": []
},
}

Ein weiteres Beispiel für das Kartenobjekt finden Sie im Abschnitt cards.

Antwort

Im Erfolgsfall wird ein leeres JSON-Objekt zurückgegeben.

Der HTTP-Statuscode zeigt an, ob die Anfrage erfolgreich war (response.status == 200) oder fehlgeschlagen ist (response.status == 500).


Verwandte Artikel: Arbeiten mit dem Server