Schließen von Aktivitäten

Eine Aktivität wird entweder durch Abschließen oder Überspringen geschlossen. Um geschlossen werden zu können, muss die Aktivität geöffnet und einem Benutzer zugewiesen sein.

Beim Schließen einer Aktivität gibt es zwei Optionen für die Anforderungs-Nutzdaten:

Leere Nutzdaten
Nutzdaten mit einer included-Notiz. (Diese Option wird verwendet, wenn Sie beim Schließen der Aktivität eine Notiz erstellen möchten. Die Nutzdaten haben keinen Datenbereich, aber einen included-Bereich.)

Alle Endpunkte für das Schließen von Aktivitäten befinden sich in der Common-API.

Abschließen einer Aktivität

Das Abschließen einer Aktivität zeigt an, dass die entsprechende Aktion ausgeführt wurde oder die zugewiesene Person über das entsprechende Problem informiert ist.

Die folgenden Nutzdaten schließen die Aktivität xc:1 ab.

POST /common/v1/activities/xc:1/complete

<no request payload>

Die folgenden Nutzdaten schließen die Aktivität xc:1 ab und erstellen eine Notiz.

POST /common/v1/activities/xc:1/complete

{
  "included": {
    "Note": [
      {
        "attributes": {
          "body": "This activity  was completed through a system API call."
        },
        "method": "post",
        "uri": "/common/v1/activities/xc:1/notes"
      }
    ]
  }
}

Überspringen einer Aktivität

Das Überspringen einer Aktivität zeigt an, dass die entsprechende Aktion nicht mehr erforderlich ist. Aktivitäten haben ein boolesches mandatory-Feld. Wenn dieses auf „true“ festgelegt ist, kann die Entität nicht übersprungen werden.

Die folgenden Nutzdaten überspringen die Aktivität xc:1.

POST /common/v1/activities/xc:1/skip

<no request payload>

Die folgenden Nutzdaten überspringen die Aktivität xc:1 und erstellen eine Notiz.

POST /common/v1/activities/xc:1/skip

{
  "included": {
    "Note": [
      {
        "attributes": {
          "body": "This activity was skipped by a system API call."
        },
        "method": "post",
        "uri": "/common/v1/activities/xc:1/notes"
      }
    ]
  }
}