タイプ | 形式 | 説明 |
---|---|---|
日付 | yyyy-MM-dd |
|
日時 | yyyy-MM-ddThh:mm:ss または yyyy-MM-ddThh:mm:ss±HH:MM |
|
ヘッダー名 | 形式 | 説明 |
---|---|---|
Host | Host: [ホスト名]:443 | リクエスト先のホスト名を指定します。 |
Content-Type | Content-Type: application/json | リクエストボディにjson形式のデータを指定する場合に指定します。 |
X-HTTP-Method-Override | X-HTTP-Method-Override: GET/POST/PUT/DELETE |
以下のリクエストを送信した場合、顧客エンティティの項目一覧を取得します。 リクエストヘッダー
POST /rest/v1/entities/columns HTTP/1.1
Host: <ホスト名>:443
Content-Type: application/json
X-HTTP-Method-Override: GET
リクエストボディ
{
"obj_name" : "customer"
}
|
Disable-RuleEngine | Disable-RuleEngine:1 | 1を指定した場合、RestAPIから各Entityの登録/更新/削除を実行した際はルールエンジンを起動しません。 |
プロパティ名 | タイプ | 説明 |
---|---|---|
code | 文字列 | エラーコードです。 |
messages | 文字列 | リソース要求を拒否した理由です。 |
メソッド | APIエンドポイント | 説明 |
---|---|---|
GET | /entities/names | eセールスマネージャーRemix REST APIがサポートしているエンティティ名の一覧を取得します。 |
GET | /entities/checkitems | 指定したチェックボックス型項目の選択肢一覧を取得します。 |
GET | /entities/selectitems | 指定したセレクト型項目の選択肢一覧を取得します。 |
GET | /entities/columns | エンティティの種類を指定し、項目一覧を取得します。 |
POST | /entities/search | eセールスマネージャーRemixに登録済みのエンティティのレコードを検索します。 複数のレコードを取得可能です。 |
GET | /entity | eセールスマネージャーRemixに登録済みのエンティティを検索し、単一のエンティティを取得します。 |
POST | /entity | eセールスマネージャーRemixに単一のエンティティを登録します。 |
PUT | /entity | eセールスマネージャーRemixに登録済みの単一のエンティティを更新します。 |
DELETE | /entity | eセールスマネージャーRemixに登録済みの単一のエンティティを削除します。 |
POST | /entities | eセールスマネージャーRemixに複数のエンティティを登録します。 |
PUT | /entities | eセールスマネージャーRemixに登録済みの複数のエンティティを更新します。 |
DELETE | /entities | eセールスマネージャーRemixに登録済みの複数のエンティティを削除します。 |
リソース要求が成功した場合は、エンティティ名の一覧を取得します。
curl -X GET -H "Content-Type: application/json" -H "X-Auth-User-Token: yourusertoken" "https://<ホスト名>/<コンテキスト名>/rest/v1/entities/names"
以下のプロパティを指定します。
パラメータ名 | タイプ | 必須 | 説明 |
---|---|---|---|
obj_name | 文字列 | 必須 | エンティティ名を指定します。 |
column_code | 数値 | 必須 | チェックボックス型項目の項目コードを指定します。 |
リソース要求が成功した場合は、チェックボックス型項目の選択肢一覧を取得します。
curl -X GET -H "Content-Type: application/json" -H "X-Auth-User-Token: yourusertoken" "https://<ホスト名>/<コンテキスト名>/rest/v1/entities/checkitems?obj_name=business&column_code=xxxxx"
以下のプロパティを指定します。
パラメータ名 | タイプ | 必須 | 説明 |
---|---|---|---|
obj_name | 文字列 | 必須 | エンティティ名を指定します。 |
column_code | 数値 | 必須 | セレクト型項目の項目コードを指定します。 |
リソース要求が成功した場合は、セレクト型項目の選択肢一覧を取得します。
curl -X GET -H "Content-Type: application/json" -H "X-Auth-User-Token: yourusertoken" "https://<ホスト名>/<コンテキスト名>/rest/v1/entities/selectitems?obj_name=customer&column_code=xxxxx"
以下のプロパティを指定します。
パラメータ名 | タイプ | 必須 | 説明 |
---|---|---|---|
obj_name | 文字列 | 必須 | エンティティ名を指定します。 |
リソース要求が成功した場合は、要求エンティティのカラム名一覧を取得します。
curl -X GET -H "Content-Type: application/json" -H "X-Auth-User-Token: yourusertoken" "https://<ホスト名>/<コンテキスト名>/rest/v1/entities/columns?obj_name=customer"
以下のプロパティを指定します。
プロパティ名 | タイプ | 必須 | 説明 |
---|---|---|---|
searchCondition | SearchCondition | 必須 | エンティティの検索条件を指定します。 |
columnCodes | 配列 | 必須 | 検索結果として取得したい項目の項目コードを指定します。 |
sortKeys | 配列 | 必須 | 検索結果の並び順(SortKey)のリストを指定します。未指定の場合、整列はおこないません。 |
fromIndex | 数値 | 必須 | 検索結果セットの取得開始位置を指定します。 ※ 未指定または0以下を指定した場合、1を指定した場合と同じ動作になります。 |
要求が成功した場合は、検索条件にマッチしたエンティティを設定します。
curl -X POST -H "Content-Type: application/json" -H "X-Auth-User-Token: yourusertoken" -d 'yourjsondata' "https://<ホスト名>/<コンテキスト名>/rest/v1/entities/search"
以下のプロパティを指定します。
パラメータ名 | タイプ | 必須 | 説明 |
---|---|---|---|
obj | 文字列 | 必須 | エンティティ名を指定します。 |
id | 文字列 | 必須 | エンティティのコードを指定します。 |
columncodes | 文字列 | 必須 | 項目の項目コードを指定します。 |
リソース要求が成功した場合は、単一のエンティティを取得します。
curl -X GET -H "Content-Type: application/json" -H "X-Auth-User-Token: yourusertoken" "https://<ホスト名>/<コンテキスト名>/rest/v1/entity?obj=customer&id=10001&columncodes=323,324,325"
以下のプロパティを指定します。
パラメータ名 | タイプ | 必須 | 説明 |
---|---|---|---|
objectName | 文字列 | 必須 | エンティティ名を指定します。 |
items | プロパティ名 | 必須 | 下記のitemsに記載されているプロパティを指定します。 |
以下のプロパティを指定します。
パラメータ名 | タイプ | 必須 | 説明 |
---|---|---|---|
column_code | 数値 | 必須 | 登録項目の項目コードを指定します。 |
text | 文字列 | テキスト型/テキストエリア型の項目の場合には、この属性に値を指定します。 全角英数字を半角英数字に、機種依存文字/特殊文字を特定の文字に変換します。また、末尾のスペースを除去します。 ※変換ルールについては、オンラインヘルプPC版の「はじめに>ご利用上の注意>4 文字入力」を参照下さい。 |
|
date | 日付または日時 | 日付/日時型の項目の場合には、この属性に値を指定します。 | |
num | 数値 | 整数型/セレクト型の項目の場合には、この属性に値を指定します。 | |
checkbox | 真偽値・配列 | チェックボックス型の項目の場合には、この属性に値を指定します。 | |
decimal | 小数 | 小数型の項目の場合には、この属性に値を指定します。 |
リソース要求が成功した場合は、単一のエンティティを登録します。
curl -X POST -H "Content-Type: application/json" -H "X-Auth-User-Token: yourusertoken" "https://<ホスト名>/<コンテキスト名>/rest/v1/entity"
以下のプロパティを指定します。
パラメータ名 | タイプ | 必須 | 説明 |
---|---|---|---|
objectName | 文字列 | 必須 | エンティティ名を指定します。 |
items | プロパティ名 | 必須 | 下記のitemsに記載されているプロパティを指定します。 |
以下のプロパティを指定します。
パラメータ名 | タイプ | 必須 | 説明 |
---|---|---|---|
column_code | 数値 | 必須 | 更新項目の項目コードを指定します。 更新したい項目とは別に、更新対象のエンティティのプライマリーキーを設定してください。 ※下図のJson形式では「顧客コード:10001」に対して顧客名を更新しています。 |
text | 文字列 | テキスト型/テキストエリア型の項目の場合には、この属性に値を指定します。 全角英数字を半角英数字に、機種依存文字/特殊文字を特定の文字に変換します。また、末尾のスペースを除去します。 ※変換ルールについては、オンラインヘルプPC版の「はじめに>ご利用上の注意>4 文字入力」を参照下さい。 |
|
date | 日付または日時 | 日付/日時型の項目の場合には、この属性に値を指定します。 | |
num | 数値 | 整数型/セレクト型の項目の場合には、この属性に値を指定します。 | |
checkbox | 真偽値・配列 | チェックボックス型の項目の場合には、この属性に値を指定します。 | |
decimal | 小数 | 小数型の項目の場合には、この属性に値を指定します。 |
リソース要求が成功した場合は、単一のエンティティを更新します。
curl -X PUT -H "Content-Type: application/json" -H "X-Auth-User-Token: yourusertoken" "https://<ホスト名>/<コンテキスト名>/rest/v1/entity"
以下のプロパティを指定します。
パラメータ名 | タイプ | 必須 | 説明 |
---|---|---|---|
objectName | 文字列 | 必須 | エンティティ名を指定します。 mergeは「customer」のみをサポートしています。 |
items | プロパティ名 | 必須 | 下記のitemsに記載されているプロパティを指定します。 |
以下のプロパティを指定します。
パラメータ名 | タイプ | 必須 | 説明 |
---|---|---|---|
column_code | 数値 | 必須 | 統合対象の項目コードを指定します。 -100:残る方の顧客コード -101:消える方の顧客コード ※下図のJson形式では「顧客コード:10252」に対して「顧客コード:10251」を統合しています。 |
num | 数値 | 対象エンティティのPKを指定します。 |
リソース要求が成功した場合は、統合処理を実施します。
curl -X PUT -H "Content-Type: application/json" -H "X-Auth-User-Token: yourusertoken" "https://<ホスト名>/<コンテキスト名>/rest/v1/entity/merge"
以下のプロパティを指定します。
パラメータ名 | タイプ | 必須 | 説明 |
---|---|---|---|
objectName | 文字列 | 必須 | エンティティ名を指定します。 |
items | プロパティ名 | 必須 | 下記のitemsに記載されているプロパティを指定します。 |
bulkRelate | 真偽値 | true:関連情報を一括削除する、false:関連情報を一括削除しない ※未指定時は、関連情報を一括削除しません ※顧客エンティティのみ |
以下のプロパティを指定します。
パラメータ名 | タイプ | 必須 | 説明 |
---|---|---|---|
column_code | 数値 | 必須 | プライマリキーの項目コードを指定します。 |
num | 数値 | 必須 |
プライマリキーが整数型/セレクト型の項目の場合には、この属性に値を指定します。 ※プライマリキーの型に合わせていずれかの属性に値を設定する |
text | 文字列 | 必須 |
プライマリキーがテキスト型/テキストエリア型の場合には、この属性に値を設定します。 ※プライマリキーの型に合わせていずれかの属性に値を設定する |
レスポンスは提供しません。
curl -X DELETE -H "Content-Type: application/json" -H "X-Auth-User-Token: yourusertoken" -d 'yourjsondata' "https://<ホスト名>/<コンテキスト名>/rest/v1/entity"
以下のプロパティを指定します。
パラメータ名 | タイプ | 必須 | 説明 |
---|---|---|---|
objectName | 文字列 | 必須 | エンティティ名を指定します。 |
items | プロパティ名 | 必須 | 下記のitemsに記載されているプロパティを指定します。 |
以下のプロパティを指定します。
パラメータ名 | タイプ | 必須 | 説明 |
---|---|---|---|
column_code | 数値 | 必須 | 登録項目の項目コードを指定します。 |
text | 文字列 | テキスト型/テキストエリア型の項目の場合には、この属性に値を指定します。 全角英数字を半角英数字に、機種依存文字/特殊文字を特定の文字に変換します。また、末尾のスペースを除去します。 ※変換ルールについては、オンラインヘルプPC版の「はじめに>ご利用上の注意>4 文字入力」を参照下さい。 |
|
date | 日付または日時 | 日付/日時型の項目の場合には、この属性に値を指定します。 | |
num | 数値 | 整数型/セレクト型の項目の場合には、この属性に値を指定します。 | |
checkbox | 真偽値・配列 | チェックボックス型の項目の場合には、この属性に値を指定します。 | |
decimal | 小数 | 小数型の項目の場合には、この属性に値を指定します。 |
リソース要求が成功した場合は、複数のエンティティを登録します。
curl -X POST -H "Content-Type: application/json" -H "X-Auth-User-Token: yourusertoken" "https://<ホスト名>/<コンテキスト名>/rest/v1/entities"
以下のプロパティを指定します。
パラメータ名 | タイプ | 必須 | 説明 |
---|---|---|---|
objectName | 文字列 | 必須 | エンティティ名を指定します。 |
items | プロパティ名 | 必須 | 下記のitemsに記載されているプロパティを指定します。 |
以下のプロパティを指定します。
パラメータ名 | タイプ | 必須 | 説明 |
---|---|---|---|
column_code | 数値 | 必須 |
更新項目の項目コードを指定します。 更新したい項目とは別に、更新対象のエンティティのプライマリーキーを設定してください。 ※下図のJson形式では「顧客コード:10001」「顧客コード:10002」を対象に、 それぞれの顧客名を更新しています。 |
text | 文字列 | テキスト型/テキストエリア型の項目の場合には、この属性に値を指定します。 全角英数字を半角英数字に、機種依存文字/特殊文字を特定の文字に変換します。また、末尾のスペースを除去します。 ※変換ルールについては、オンラインヘルプPC版の「はじめに>ご利用上の注意>4 文字入力」を参照下さい。 |
|
date | 日付または日時 | 日付/日時型の項目の場合には、この属性に値を指定します。 | |
num | 数値 | 整数型/セレクト型の項目の場合には、この属性に値を指定します。 | |
checkbox | 真偽値・配列 | チェックボックス型の項目の場合には、この属性に値を指定します。 | |
decimal | 小数 | 小数型の項目の場合には、この属性に値を指定します。 |
リソース要求が成功した場合は、複数のエンティティを更新します。
curl -X PUT -H "Content-Type: application/json" -H "X-Auth-User-Token: yourusertoken" "https://<ホスト名>/<コンテキスト名>/rest/v1/entities"
以下のプロパティを指定します。
パラメータ名 | タイプ | 必須 | 説明 |
---|---|---|---|
objectName | 文字列 | 必須 | エンティティ名を指定します。 |
items | プロパティ名 | 必須 | 下記のitemsに記載されているプロパティを指定します。 |
bulkRelate | 真偽値 | true:関連情報を一括削除する、false:関連情報を一括削除しない ※未指定時は、関連情報を一括削除しません ※顧客エンティティのみ |
以下のプロパティを指定します。
パラメータ名 | タイプ | 必須 | 説明 |
---|---|---|---|
column_code | 数値 | 必須 | プライマリキーの項目コードを指定します。 |
num | 数値 | 必須 |
プライマリキーが整数型/セレクト型の項目の場合には、この属性に値を指定します。 ※プライマリキーの型に合わせていずれかの属性に値を設定する |
text | 文字列 | 必須 |
プライマリキーがテキスト型/テキストエリア型の場合には、この属性に値を設定します。 ※プライマリキーの型に合わせていずれかの属性に値を設定する |
レスポンスは提供しません。
curl -X DELETE -H "Content-Type: application/json" -H "X-Auth-User-Token: yourusertoken" -d 'yourjsondata' "https://<ホスト名>/<コンテキスト名>/rest/v1/entities"