BPMObject item SearchCondition SearchConditionItem SortKey Column CheckItem SelectItem Response

BPMObject

登録・更新・削除時のエンティティを表します。

Properties

プロパティ名	タイプ	説明
items	配列	エンティティの属性を表すitemのリストです。
objectName	文字列	エンティティ名です。
relatedObjects	配列	関連エンティティを表すBPMObjectのリストです。削除時には設定できません。

JSON形式

{ "items" : [ #item ] , "objectName" : "customer" , "relatedObjects" : [ #BPMObject ] }

item

エンティティの属性値を表します。

Properties

プロパティ名	タイプ	説明
column_code	数値	ColumnオブジェクトのcolumnCodeを指すことで、どの項目の値なのかを表します。
text	文字列	テキスト型／テキストエリア型の項目の場合には、この属性に値を指定します。
date	日付または日時	日付／日時型の項目の場合には、この属性に値を指定します。
num	数値	整数型／セレクト型の項目の場合には、この属性に値を指定します。
checkbox	真偽値・配列	チェックボックス型の項目の場合には、この属性に値を指定します。
decimal	小数	小数型の項目の場合には、この属性に値を指定します。

JSON形式

{ "column_code" : 105 , "text" : "営業太郎", }, { "column_code" : 104 , "date" : "2020-04-01T09:00:00", }, { "column_code" : 102 , "num" : 10001, }, { "column_code" : 144 , "checkbox" : [true, false, false] }, { "column_code" : 10001 , "decimal" : 1.23 }

SearchCondition

検索条件を表します。

Properties

プロパティ名	タイプ	説明
targetObjectName	文字列	検索対象のエンティティ名です。
items	配列	検索条件式を表すSearchConditionItemのリストです。
notExists	真偽値	true : relatedObjectConditionsでマッチする関連エンティティが存在しない場合に「条件に合致」と見なします。 false : relatedObjectConditionsでマッチする関連エンティティが存在する場合に「条件に合致」と見なします。
relatedObjectConditions	配列	関連エンティティの検索条件を表すSearchConditionのリストです。複数指定した場合はAND条件で結合されます。

JSON形式

{ "targetObjectName" : "customer" , "items" : [ #SearchConditionItem ] , "notExists" : true , "relatedObjectConditions" : [ #SearchCondition ] }

SearchConditionItem

検索条件式を表します。

Properties

プロパティ名	タイプ	説明
columnCode	数値	検索対象の項目です。
operator	文字列	検索条件の演算子です。
text	文字列	テキスト型／テキストエリア型の項目の場合には、この属性に値を指定します。
date	日付または日時	日付／日時型の項目の場合には、この属性に値を指定します。
num	数値	整数型／セレクト型の項目の場合には、この属性に値を指定します。
checkBox	真偽値・配列	チェックボックス型の項目の場合には、この属性に値を指定します。
decimal	数値	小数型の項目の場合には、この属性に値を指定します。
null	真偽値	「true」を指定することで、指定したエンティティに対してNULL検索を行うことが出来ます。 ※NULL検索を行う場合、operatorの条件式に「=」を指定してください。
notNull	真偽値	「true」を指定することで、指定したエンティティに対してNOT NULL検索を行うことが出来ます。 ※NOT NULL検索を行う場合、operatorの条件式に「=」を指定してください。

operator

以下はoperatorに指定できる演算子です。

指定可能な演算子(符号)	データ型	説明
=	テキスト・セレクト・日付・整数・テキストエリア・チェックボックス	「等しい」を表す符号です。テキスト型／テキストエリア型では、指定した検索条件値に完全に合致するエンティティのみを抽出します。チェックボックス型では、「true」を指定した選択肢のうち、1つ以上の選択肢にチェックが入れられているエンティティのみを抽出します。セレクト型／日付型／整数型では、指定した検索条件値に合致するエンティティのみを抽出します。 ※日付型の最小単位は「秒」です。タイムゾーンの違いは考慮しません
<	日付	「より小さい」を表す符号です。日付型では、指定した条件値よりも過去の値を持つエンティティのみを抽出します。
<=	整数	「以下」を表す符号です。整数型では、指定した条件値よりも小さいまたは同一の値を持つエンティティのみを抽出します。
>=	日付・整数	「以上」を表す符号です。日付型では、指定した条件値よりも未来または同一の値を持つエンティティのみを抽出します。整数型では、指定した条件値よりも大きいまたは同一の値を持つエンティティのみを抽出します。
forward	テキスト・テキストエリア	「前方一致」を表す符号です。テキスト型／テキストエリア型では、指定した検索条件値に文字列の先頭が合致するエンティティのみを抽出します。
backward	テキスト・テキストエリア	「後方一致」を表す符号です。テキスト型／テキストエリア型では、指定した検索条件値に文字列の末尾が合致するエンティティのみを抽出します。
partly	テキスト・テキストエリア	「部分一致」を表す符号です。テキスト型／テキストエリア型では、指定した検索条件値を含むエンティティのみを抽出します。

JSON形式

{ "columnCode" : 105 , "operator" : "forward " , "text" : "営業" }, { "columnCode" : 104 , "operator" : ">=" , "date" : "2020-04-01" }, { "columnCode" : 102 , "operator" : "=" , "num" : 10001 }, { "columnCode" : 144 , "operator" : "=" , "checkBox" : [true, false, false] }, { "columnCode" : 10001 , "operator" : "=" , "decimal" : 1.23 }, { "columnCode" : 10002 , "operator" : "=" , "null" : true }, { "columnCode" : 10003 , "operator" : "=" , "notNull" : true }

SortKey

検索結果の並び順を表します。

Properties

プロパティ名	タイプ	説明
columnCode	数値	ソート対象の項目です。
desc	真偽値	整列方法です。 false : 昇順 true : 降順

JSON形式

{ "columnCode" : 318 , "desc" : true }

Column

項目を表します。

Properties

プロパティ名	タイプ	説明
code	数値	項目に割り当てられた一意識別子です。同一エンティティ内で一意になります。
name	文字列	項目名です。
type	数値	項目のデータ型を表すコード値です。

Type

以下はColumn.typeのコード一覧です。

コード値	データ型	説明
0	テキスト型	テキスト型項目を表します。
1	セレクト型	セレクト型項目を表します。
2	日付型	日付型項目を表します。
3	整数型	整数型項目を表します。
4	テキストエリア型	テキストエリア型項目を表します。
5	小数型	小数型項目を表します。
6	チェックボックス型	チェックボックス型項目を表します。
11	日時型	日時型項目を表します。

JSON形式

{ "code" : 318 , "name" : "顧客コード" , "type" : 3 }

CheckItem

チェックボックス型項目の選択肢を表します。

Properties

プロパティ名	タイプ	説明
checkItemCode	数値	選択肢の一意識別子です。同一チェックボックス型項目内で一意になります。
checkItemName	文字列	選択肢名です。

JSON形式

{ "checkItemCode" : 1 , "checkItemName" : "選択肢1" }

SelectItem

セレクト型項目の選択肢を表します。

Properties

プロパティ名	タイプ	説明
selectItemCode	数値	選択肢の一意識別子です。同一セレクト型項目内で一意になります。
selectItemName	文字列	選択肢名です。
selectItemNumber	文字列	選択肢番号です。

JSON形式

{ "selectItemCode" : 1 , "selectItemName" : "選択肢1" , "selectItemNumber" : "" }

Response

エラー応答情報を表します。

Properties

プロパティ名	タイプ	説明
code	文字列	エラーコードです。
message	文字列	リソース要求を拒否した理由です。

JSON形式

{ "code" : "500" , "message" : "エラーメッセージ" }