intra-mart Accel Platform IM-Workflow 仕様書 第37版 2024-04-01

6.1.9.15.2. My検索条件登録

My検索条件を登録します。

6.1.9.15.2.1. HTTP リクエスト

POST /api/workflow/my-search-conditions

6.1.9.15.2.2. リクエストボディ

6.1.9.15.2.2.1. JSON

{
  "data": "string",
  "mySearchName": "string",
  "taskStatus": "string"
}

6.1.9.15.2.2.2. 詳細

プロパティ名 論理名 説明
data 検索条件情報 string 詳細は 検索条件情報 を参照してください。
mySearchName My検索名 string  
taskStatus タスクステータス string タスクステータスを表すコードの詳細は タスクステータス を参照してください。

6.1.9.15.2.2.2.1. 検索条件情報

検索条件情報には、タスクステータスに対応した案件一覧取得APIの検索条件項目をプロパティとした構造のオブジェクトをJSON文字列化した値を指定してください。

タスクステータスと案件一覧取得APIの対応については タスクステータス を参照してください。
各APIの検索条件項目については detailSearchCondition プロパティ を参照してください。
  • 標準カラムの指定方法

    "%カラムID%": {
      "value": "string"
    }
    
  • 標準カラム(日付情報)の指定方法
    value に yyyy/MM/dd 形式の値を指定してください。
    formatted に アカウントコンテキストの日付表示形式の値を指定してください。
    "%カラムID%": {
      "value": "string",
      "formatted": "string"
    }
    
  • 案件プロパティカラムの指定方法
    範囲検索の場合は1要素目に開始の値、2要素目に終了の値を指定してください。
    案件プロパティの型が数値であっても string で指定してください。
    "%案件プロパティキー%": {
      "value": [
        "string"
      ]
    }
    
  • 未処理、処理済み(未完了案件、完了案件)における権限条件( authz )の指定方法

コラム

未処理の場合の例

"data": {
  "applyBaseDateFrom":{
    "value":"2020/07/01",
    "formatted":"2020年07月01日"
  },
  "processAuth":{
    "value":[
      "apply","applyAct"
    ]
  },
  "matterNumber":{
    "value":"10001"
  },
  "applyDateTo":{
    "value":"2020/7/31",
    "formatted":"2020年07月31日"
  },
  "status":{
    "value":"applywait"
  },
  "matterprop_num":{
    "value":[
      "10","500"
    ],
    "isMatterProperty":true
  }
}

注意

「案件一覧」画面では、 confirmed , unconfirmed プロパティは考慮されません。(タスクステータスとして区別しているため)

6.1.9.15.2.3. エラーコード

エラーコード エラーメッセージ 備考
8812 My検索名が未指定です。 リクエストボディ - mySearchName が未指定の場合
8813 My検索名が許可された最大文字数を超えています。 リクエストボディ - mySearchName が最大文字数(999バイト)を超えた場合
8815 タスクステータスが未指定です。 リクエストボディ - taskStatus が未指定の場合
8816 タスクステータスが不正です。 リクエストボディ - taskStatus が 「 タスクステータス 」 のコード値と一致しない場合
8817 検索データが未指定です。 リクエストボディ - data が未指定の場合
8818 My検索情報登録パラメータが未指定です。 リクエストボディ が未指定の場合
8819 システムエラーが発生しました。管理者にお問い合わせください。 My検索IDの採番に失敗した場合
8820 My検索情報の登録に失敗しました。 My検索情報の登録に失敗した場合