Schließen von Aktivitäten

Eine allgemeine 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. (Genehmigungsaktivitäten, die weiter unten in diesem Thema erläutert werden, werden auf andere Weise geschlossen.)

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

Genehmigen einer Genehmigungsaktivität

Genehmigungsaktivitäten sind mit Aktionen verknüpft, die eine Genehmigung eines Benutzers mit ausreichender Berechtigung erfordern, z. B. eines Managers. Genehmigungsaktivitäten werden entweder durch Genehmigen oder Ablehnen der Aktivität geschlossen. Dadurch wird die zugehörige Aktion zugelassen oder verhindert.

Nur Genehmigungsaktivitäten können durch Genehmigung oder Ablehnung geschlossen werden. Allgemeine Aktivitäten müssen durch Abschließen oder Überspringen geschlossen werden.

Genehmigungsaktivitäten beinhalten häufig finanzielle Aktivitäten, wie das Senden von Geld an einen Versicherten oder eine dritte Partei. Als zusätzliche Schutzebene können aufrufende Anwendungen Prüfsummen mit Aufrufen des /approve-Endpunkts verwenden, um sicherzustellen, dass zwischen dem Abrufen und der Genehmigung der Aktivität keine Änderungen vorgenommen wurden. Weitere Informationen zu Prüfsummen finden Sie unter Verlorene Aktualisierungen und Prüfsummen.

Beim Genehmigen einer Aktivität gibt es folgende Optionen für die Anforderungs-Nutzdaten:

  • Leere Nutzdaten
  • Nutzdaten mit einer Genehmigungsbegründung. (Dies ist ein Zeichenfolgenwert, der beschreibt, warum die Aktivität genehmigt oder abgelehnt wurde.)
  • Nutzdaten mit einer included-Notiz.
  • Nutzdaten mit einer Genehmigungsbegründung und einer included-Notiz.

Die folgenden Nutzdaten genehmigen die Aktivität xc:2.

POST /common/v1/activities/xc:2/approve

<no request payload>

Die folgenden Nutzdaten genehmigen die Aktivität xc:2 mit einer Genehmigungsbegründung.

POST /common/v1/activities/xc:2/approve

{
  "data":
    {
      "attributes": {
        "approvalRationale": "Higher reserve approved because claimant is gold-tier customer."
      }
    }
}

Die folgenden Nutzdaten genehmigen die Aktivität xc:2 mit einer Genehmigungsbegründung und einer Notiz.

POST /common/v1/activities/xc:2/approve

{
  "data":
    {
      "attributes": {
        "approvalRationale": " Higher reserve approved because claimant is gold-tier customer"
      }
    },
  "included": {
    "Note": [
      {
        "attributes": {
          "body": "This activity was approved through a system API call."
        },
        "method": "post",
        "uri": "/common/v1/activities/xc:2/notes"
      }
    ]
  }
}

Zurzeit gibt es keine Cloud-API-Endpunkte, die Genehmigungsaktivitäten ablehnen.