アクティビティのクローズ

一般的なアクティビティは、それを完了するか、スキップすることによってクローズされます。クローズするには、アクティビティがオープンしており、ユーザーにアサインされている必要があります（このトピックの後半で説明する承認アクティビティは別の方法でクローズされます）。

アクティビティをクローズする場合、要求ペイロード用の 2 つのオプションがあります。

  • 空のペイロード
  • included セクションに備考・経緯を持つペイロード（このオプションは、アクティビティのクローズ中に備考・経緯を作成する場合に使用されます。ペイロードには、データセクションはありませんが、included セクションはあります。）

アクティビティをクローズするためのすべてのエンドポイントが 共通 API 内に存在します。

アクティビティの完了

アクティビティの完了は、対応するアクションが実行されたか、アサイン先が対応する問題を認識していることを示します。

以下のペイロードは、アクティビティ xc:1 を完了します。

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

<no request payload>

以下のペイロードは、アクティビティ xc:1 を完了して、備考・経緯を作成します。

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

アクティビティのスキップ

アクティビティのスキップは、対応するアクションを実行する必要がなくなったことを示します。アクティビティには、mandatory Boolean フィールドがあります。これが true に設定されている場合、アクティビティをスキップできません。

以下のペイロードは、アクティビティ xc:1 をスキップします。

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

<no request payload>

以下のペイロードは、アクティビティ xc:1 をスキップして、備考・経緯を作成します。

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

承認アクティビティの承認

承認アクティビティは、マネージャのように十分な権限を持っているユーザーから、承認を受ける必要があるアクションに関連付けられます。承認アクティビティは、アクティビティを承認または却下することによってクローズされます。これにより、関連するアクションが許可または回避されます。

承認または却下によってクローズできるのは、承認アクティビティだけです。一般的なアクティビティは、完了またはスキップによってクローズする必要があります。

承認アクティビティの多くに、被保険者または相手方当事者への送金などの財務アクティビティが含まれます。追加された保護層として、呼び出し元アプリケーションが /approve エンドポイントへの呼び出しでチェックサムを使用して、取得から承認までの間にアクティビティが変更されていないことを保証できます。チェックサムの詳細については、ロストアップデートとチェックサムを参照してください。

アクティビティを承認する場合の要求ペイロード用のオプションは次のとおりです。

  • 空のペイロード
  • 承認理由を含むペイロード（これは、アクティビティが承認または却下された理由を示す文字列値です。）
  • included セクションに備考・経緯を持つペイロード
  • 承認理由と included セクションの備考・経緯を含むペイロード

以下のペイロードは、アクティビティ xc:2 を承認します。

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

<no request payload>

以下のペイロードは、承認理由を含むアクティビティ xc:2 を承認します。

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

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

以下のペイロードは、承認理由と備考・経緯を含むアクティビティ xc:2 を承認します。

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

現時点で、承認アクティビティを却下する Cloud API エンドポイントは存在しません。