共通仕様 Resource一覧 GET /entities/names GET /entities/checkitems GET /entities/selectitems GET /entities/columns POST /entities/search GET /entity POST /entity PUT /entity DELETE /entity POST /entities PUT /entities DELETE /entities GET /entity/file POST /entity/file PUT /entity/file DELETE /entity/file

共通仕様

プロトコル

HTTPS

メディアタイプ

以下のメディアタイプをサポートします。

application/json

文字コード

UTF-8

日時形式

以下の日時形式をサポートします。

タイプ	形式	説明
日付	yyyy-MM-dd	「yyyy」は西暦4桁、「MM」は月2桁、「dd」は日2桁を表します。 2018年1月1日は次のように表します。例) 「2018-01-01」指定桁に満たない場合は0を補完します。例) 「2018-1-1」 -> 「2018-01-01」月日を省略した場合は01で補完します。例) 「2018」 -> 「2018-01-01」「2018-01」 -> 「2018-01-01」
日時	yyyy-MM-ddThh:mm:ss または yyyy-MM-ddThh:mm:ss±HH:MM	「yyyy」は西暦4桁、「MM」は月2桁、「dd」は日2桁を表します。「yyyy-MM-dd」と「hh:mm:ss」の間の「T」は固定値です。「±HH:MM」には、協定世界時（UTC）との時刻の差を指定します。「±HH:MM」を省略した場合は協定世界時（UTC）の時刻になります。日本時間（JST）の2018年1月1日1時1分は次のように表せます。例）「2018-01-01T01:01:00+09:00」

認証

以下の認証方式をサポートします。

ユーザー認証

HTTPヘッダーに「X-Auth-User-Token」を追加し、[社員番号：パスワード]をBASE64でエンコードした値を設定します。

社員番号がesmremix、パスワードがesmremix123であるユーザー（esmremix:esmremix123）を BASE64でエンコードした値。

ZXNtcmVtaXg6ZXNtcmVtaXgxMjM=

上記値を設定した「X-Auth-User-Token」の設定。

X-Auth-User-Token: ZXNtcmVtaXg6ZXNtcmVtaXgxMjM=

APIトークン認証

HTTPヘッダーの「X-Auth-API-Token」にeセールスマネージャーAPIトークンを設定します。

以下はAPIトークン「YWRtaW4wMTIzNDU3ODk=」を指定した場合の「X-Auth-API-Token」になります。※APIトークンは管理者画面から生成できます。

X-Auth-API-Token: YWRtaW4wMTIzNDU3ODk=

リクエストヘッダー

ヘッダー名	形式	説明
Host	Host: [ホスト名]:443	リクエスト先のホスト名を指定します。
Content-Type	Content-Type: application/json	リクエストボディにjson形式のデータを指定する場合に指定します。
X-HTTP-Method-Override	X-HTTP-Method-Override: GET/POST/PUT/DELETE	HTTPメソッドを上書きします HTTPメソッド「POST」使用時のみ有効です。全てのREST APIで利用できます。 X-HTTP-Method-Overrideに指定するHTTPメソッド名は大文字のみ使用可能です。 URIの長さが4KBを超えるGETリクエストが送信された場合、X-HTTP-Method-Overrideヘッダーが自動的に付与され、POSTリクエストとして送信されます。 HTTPメソッドの制御している環境の場合は「X-HTTP-Method-Override」をヘッダーに設定してください。PUTを制御している場合は「X-HTTP-Method-Override:PUT」と設定してください。以下のリクエストを送信した場合、顧客エンティティの項目一覧を取得します。リクエストヘッダー POST /rest/v1/entities/columns HTTP/1.1 Host: <ホスト名>:443 Content-Type: application/json X-HTTP-Method-Override: GET リクエストボディ { "obj_name" : "customer" }

ヘッダー名

形式

説明

Host

Host: [ホスト名]:443

リクエスト先のホスト名を指定します。

Content-Type

Content-Type: application/json

リクエストボディにjson形式のデータを指定する場合に指定します。

X-HTTP-Method-Override

X-HTTP-Method-Override: GET/POST/PUT/DELETE

HTTPメソッドを上書きします
HTTPメソッド「POST」使用時のみ有効です。
全てのREST APIで利用できます。
X-HTTP-Method-Overrideに指定するHTTPメソッド名は大文字のみ使用可能です。
URIの長さが4KBを超えるGETリクエストが送信された場合、X-HTTP-Method-Overrideヘッダーが自動的に付与され、POSTリクエストとして送信されます。
HTTPメソッドの制御している環境の場合は「X-HTTP-Method-Override」をヘッダーに設定してください。PUTを制御している場合は「X-HTTP-Method-Override:PUT」と設定してください。

以下のリクエストを送信した場合、顧客エンティティの項目一覧を取得します。

リクエストヘッダー

POST /rest/v1/entities/columns HTTP/1.1 Host: <ホスト名>:443 Content-Type: application/json X-HTTP-Method-Override: GET

リクエストボディ

{ "obj_name" : "customer" }

レスポンス

リソース要求が正常終了でない場合、以下のエラー応答情報を受け取ります。

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

JSON形式

{ "code" : "500" , "messages" : [ "エラーメッセージ" ] }

エンティティ名一覧の取得

紐付項目により関連シートを紐付する等の操作によりエンティティが増減する場合があります。その際、最新のエンティティ名一覧を取得する必要があります。
「GET /entities/names」よりエンティティ名一覧を取得してください。

エンティティ項目一覧の取得

シートに入力項目を追加する等の操作によりエティティの項目が増減する場合があります。その際、最新のエンティティの項目一覧を取得する必要があります。
「GET /entities/columns」よりエンティティの項目一覧を取得してください。

技術支援

本リファレンス以上の技術支援をご希望の場合は弊社営業担当までご連絡ください。（有償）

Resource一覧

メソッド	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に登録済みの複数のエンティティを削除します。
GET	/entity/file	各シートのファイル型項目と活動のドキュメント項目に登録されているファイルを取得します。
POST	/entity/file	各シートのファイル型項目と活動のドキュメント項目にファイルを登録します。
PUT	/entity/file	各シートのファイル型項目と活動のドキュメント項目に登録されているファイルを更新します。
DELETE	/entity/file	各シートのファイル型項目と活動のドキュメント項目に登録されているファイルを削除します。

GET /entities/names

Request

HTTP request

GET https://<ホスト名>[:<ポート番号>]/<コンテキスト名>/rest/v1/entities/names

Parameters

パラメータは提供していません。

Response

リソース要求が成功した場合は、エンティティ名の一覧を取得します。

JSON形式

"names":[ "customer","business" . . . ]

Example

curl -X GET -H "Content-Type: application/json" -H "X-Auth-User-Token: yourusertoken" "https://<ホスト名>/<コンテキスト名>/rest/v1/entities/names"

GET /entities/checkitems

【注意】
DBカスタマイズ機能によって追加されたチェックボックス型項目（columnCode >= 10000）にのみ適用されます。
eセールスマネージャーRemixがあらかじめ用意している項目（デフォルト項目）で使用する選択肢は、項目ごとに別途定義されています。詳細は、各エンティティのリファレンスを参照ください。

Request

HTTP request

GET https://<ホスト名>[:<ポート番号>]/<コンテキスト名>/rest/v1/entities/checkitems

Parameters

以下のプロパティを指定します。

パラメータ名	タイプ	必須	説明
obj_name	文字列	必須	エンティティ名を指定します。
column_code	数値	必須	チェックボックス型項目の項目コードを指定します。

Response

リソース要求が成功した場合は、チェックボックス型項目の選択肢一覧を取得します。

JSON形式

[ #CheckItem ]

Example

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"

GET /entities/selectitems

【注意】
DBカスタマイズ機能によって追加されたセレクト型項目（columnCode >= 10000）にのみ適用されます。
eセールスマネージャーRemixがあらかじめ用意している項目（デフォルト項目）で使用する選択肢は、項目ごとに別途定義されています。詳細は、各エンティティのリファレンスを参照ください。

Request

HTTP request

GET https://<ホスト名>[:<ポート番号>]/<コンテキスト名>/rest/v1/entities/selectitems

Parameters

以下のプロパティを指定します。

パラメータ名	タイプ	必須	説明
obj_name	文字列	必須	エンティティ名を指定します。
column_code	数値	必須	セレクト型項目の項目コードを指定します。

Response

リソース要求が成功した場合は、セレクト型項目の選択肢一覧を取得します。

JSON形式

[ #SelectItem ]

Example

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"

GET /entities/columns

Request

HTTP request

GET https://<ホスト名>[:<ポート番号>]/<コンテキスト名>/rest/v1/entities/columns

Parameters

以下のプロパティを指定します。

パラメータ名	タイプ	必須	説明
obj_name	文字列	必須	エンティティ名を指定します。

Response

リソース要求が成功した場合は、要求エンティティのカラム名一覧を取得します。

JSON形式

[ #Column ]

Example

curl -X GET -H "Content-Type: application/json" -H "X-Auth-User-Token: yourusertoken" "https://<ホスト名>/<コンテキスト名>/rest/v1/entities/columns?obj_name=customer"

POST /entities/search

Request

HTTP request

POST https://<ホスト名>[:<ポート番号>]/<コンテキスト名>/rest/v1/entities/search

Request body

以下のプロパティを指定します。

プロパティ名	タイプ	必須	説明
searchCondition	SearchCondition	必須	エンティティの検索条件を指定します。
columnCodes	配列	必須	検索結果として取得したい項目の項目コードを指定します。
sortKeys	配列	必須	検索結果の並び順（SortKey）のリストを指定します。未指定の場合、整列はおこないません。
fromIndex	数値	必須	検索結果セットの取得開始位置を指定します。 ※ 未指定または0以下を指定した場合、1を指定した場合と同じ動作になります。

JSON形式

{ "searchCondition" : #SearchCondition , "columnCodes" : [ 301,318,304 ] , "sortKeys" : [ #SortKey ] , "fromIndex" : 1 }

Response

要求が成功した場合は、検索条件にマッチしたエンティティを設定します。

JSON形式

{ "hits": 1, "values": [ { "obj_name":"customer", "item_data": [ { "column": { "code": 301, "name": "company_name", "type": 0 }, "column_code": null, "text": "顧客1", "num": null, "decimal": null, "date": null, "checkbox": null, "values": null }, { "column": { "code": 318, "name": "COMPANY_CODE", "type": 3 }, "column_code": null, "text": null, "num": 10001, "decimal": null, "date": null, "checkbox": null, "values": null } ] } ] }

紐付型項目による関連エンティティの条件を用いた検索

通常のエンティティ項目値検索の他に拡張シートに登録されている紐付項目を用いて検索することが出来ます。
指定順序は以下になります。

紐付項目により関連付けされたエンティティの検索条件を「SearchCondition」に指定します。この時「target_object_name」属性値は「関連エンティティ名@紐付項目カラム名」を指定します。
上記で指定した「SearchCondition」を検索対象の「SearchCondition」の「related_object_conditions」属性に指定します。

Example

curl -X POST -H "Content-Type: application/json" -H "X-Auth-User-Token: yourusertoken" -d 'yourjsondata' "https://<ホスト名>/<コンテキスト名>/rest/v1/entities/search"

GET /entity

Request

HTTP request

GET https://<ホスト名>[:<ポート番号>]/<コンテキスト名>/rest/v1/entity

Parameters

以下のプロパティを指定します。

パラメータ名	タイプ	必須	説明
obj	文字列	必須	エンティティ名を指定します。
id	文字列	必須	エンティティのコードを指定します。
columncodes	文字列	必須	項目の項目コードを指定します。

Response

リソース要求が成功した場合は、単一のエンティティを取得します。

JSON形式

{ "value": { "obj_name":"business", "item_data" : [ { "column" : { "code" : 201, "name" : "SALES_CODE", "type" : 3 }, "column_code" : null, "text" : null, "num" : 10001, "decimal" : null, "date" : null, "checkbox" : null, "values" : null }, ・・ ] } }

Example

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"

POST /entity

Request

HTTP request

POST https://<ホスト名>[:<ポート番号>]/<コンテキスト名>/rest/v1/entity

Parameters

以下のプロパティを指定します。

パラメータ名	タイプ	必須	説明
objectName	文字列	必須	エンティティ名を指定します。
items	プロパティ名	必須	下記のitemsに記載されているプロパティを指定します。

items

以下のプロパティを指定します。

パラメータ名	タイプ	必須	説明
column_code	数値	必須	登録項目の項目コードを指定します。
text	文字列		テキスト型／テキストエリア型の項目の場合には、この属性に値を指定します。全角英数字を半角英数字に、機種依存文字/特殊文字を特定の文字に変換します。また、末尾のスペースを除去します。 ※変換ルールについては、オンラインヘルプPC版の「はじめに＞ご利用上の注意＞4 文字入力」を参照下さい。
date	日付または日時		日付／日時型の項目の場合には、この属性に値を指定します。
num	数値		整数型／セレクト型の項目の場合には、この属性に値を指定します。
checkbox	真偽値・配列		チェックボックス型の項目の場合には、この属性に値を指定します。
decimal	小数		小数型の項目の場合には、この属性に値を指定します。

JSON形式

{ "objectName": "customer", "items": [ { "column_code": 301, "text": "Restで登録55" } ] }

Response

リソース要求が成功した場合は、単一のエンティティを登録します。

JSON形式

"primarykey" : xxxxx

Example

curl -X POST -H "Content-Type: application/json" -H "X-Auth-User-Token: yourusertoken" "https://<ホスト名>/<コンテキスト名>/rest/v1/entity"

PUT /entity

Request

HTTP request

PUT https://<ホスト名>[:<ポート番号>]/<コンテキスト名>/rest/v1/entity

Parameters

以下のプロパティを指定します。

パラメータ名	タイプ	必須	説明
objectName	文字列	必須	エンティティ名を指定します。
items	プロパティ名	必須	下記のitemsに記載されているプロパティを指定します。

items

以下のプロパティを指定します。

パラメータ名	タイプ	必須	説明
column_code	数値	必須	更新項目の項目コードを指定します。更新したい項目とは別に、更新対象のエンティティのプライマリーキーを設定してください。 ※下図のJson形式では「顧客コード:10001」に対して顧客名を更新しています。
text	文字列		テキスト型／テキストエリア型の項目の場合には、この属性に値を指定します。全角英数字を半角英数字に、機種依存文字/特殊文字を特定の文字に変換します。また、末尾のスペースを除去します。 ※変換ルールについては、オンラインヘルプPC版の「はじめに＞ご利用上の注意＞4 文字入力」を参照下さい。
date	日付または日時		日付／日時型の項目の場合には、この属性に値を指定します。
num	数値		整数型／セレクト型の項目の場合には、この属性に値を指定します。
checkbox	真偽値・配列		チェックボックス型の項目の場合には、この属性に値を指定します。
decimal	小数		小数型の項目の場合には、この属性に値を指定します。

JSON形式

{ "objectName": "customer", "items": [ { "column_code": 301, "text": "顧客変更1" }, { "column_code": 318, "num": 10001 } ] }

Response

リソース要求が成功した場合は、単一のエンティティを更新します。

JSON形式

"primarykey" : xxxxx

Example

curl -X PUT -H "Content-Type: application/json" -H "X-Auth-User-Token: yourusertoken" "https://<ホスト名>/<コンテキスト名>/rest/v1/entity"

DELETE /entity

Request

HTTP request

DELETE https://<ホスト名>[:<ポート番号>]/<コンテキスト名>/rest/v1/entity

Parameters

以下のプロパティを指定します。

パラメータ名	タイプ	必須	説明
objectName	文字列	必須	エンティティ名を指定します。
items	プロパティ名	必須	下記のitemsに記載されているプロパティを指定します。
bulkRelate	真偽値		true:関連情報を一括削除する、false:関連情報を一括削除しない ※未指定時は、関連情報を一括削除しません ※顧客エンティティのみ

items

以下のプロパティを指定します。

パラメータ名	タイプ	必須	説明
column_code	数値	必須	プライマリキーの項目コードを指定します。
num	数値	必須	プライマリキーが整数型／セレクト型の項目の場合には、この属性に値を指定します。 ※プライマリキーの型に合わせていずれかの属性に値を設定する
text	文字列	必須	プライマリキーがテキスト型／テキストエリア型の場合には、この属性に値を設定します。 ※プライマリキーの型に合わせていずれかの属性に値を設定する

JSON形式

例）customer(顧客)テーブルのレコードを削除する場合※プライマリキーが1つのケース

{ "objectName": "customer", "items": [ { "column_code": 301, "num": 10001 } ] }

JSON形式

例）business_employee(自社担当者)テーブルのレコードを削除する場合※プライマリキーが複数あるケース

{ "objectName": "business_employee", "items": [ { "column_code": -100, "num": 10001 }, { "column_code": -101, "num": 1 } ] }

JSON形式

例）customer(顧客)テーブルのレコードを関連情報も一括削除する場合※プライマリキーが1つのケース

{ "objectName": "customer", "items": [ { "column_code": 301, "num": 10001 }, "bulkRelate": true ] }

Response

レスポンスは提供しません。

Example

curl -X DELETE -H "Content-Type: application/json" -H "X-Auth-User-Token: yourusertoken" -d 'yourjsondata' "https://<ホスト名>/<コンテキスト名>/rest/v1/entity"

POST /entities

Request

HTTP request

POST https://<ホスト名>[:<ポート番号>]/<コンテキスト名>/rest/v1/entities

Parameters

以下のプロパティを指定します。

パラメータ名	タイプ	必須	説明
objectName	文字列	必須	エンティティ名を指定します。
items	プロパティ名	必須	下記のitemsに記載されているプロパティを指定します。

items

以下のプロパティを指定します。

パラメータ名	タイプ	必須	説明
column_code	数値	必須	登録項目の項目コードを指定します。
text	文字列		テキスト型／テキストエリア型の項目の場合には、この属性に値を指定します。全角英数字を半角英数字に、機種依存文字/特殊文字を特定の文字に変換します。また、末尾のスペースを除去します。 ※変換ルールについては、オンラインヘルプPC版の「はじめに＞ご利用上の注意＞4 文字入力」を参照下さい。
date	日付または日時		日付／日時型の項目の場合には、この属性に値を指定します。
num	数値		整数型／セレクト型の項目の場合には、この属性に値を指定します。
checkbox	真偽値・配列		チェックボックス型の項目の場合には、この属性に値を指定します。
decimal	小数		小数型の項目の場合には、この属性に値を指定します。

JSON形式

[ { "objectName": "customer", "items": [ { "column_code": 301, "text": "顧客1" } ] }, { "objectName": "customer", "items": [ { "column_code": 301, "text": "顧客2" } ] } ]

Response

リソース要求が成功した場合は、複数のエンティティを登録します。

JSON形式

"primarykey" : [ xxxxx, xxxxx . . . ]

Example

curl -X POST -H "Content-Type: application/json" -H "X-Auth-User-Token: yourusertoken" "https://<ホスト名>/<コンテキスト名>/rest/v1/entities"

PUT /entities

Request

HTTP request

PUT https://<ホスト名>[:<ポート番号>]/<コンテキスト名>/rest/v1/entities

Parameters

以下のプロパティを指定します。

パラメータ名	タイプ	必須	説明
objectName	文字列	必須	エンティティ名を指定します。
items	プロパティ名	必須	下記のitemsに記載されているプロパティを指定します。

items

以下のプロパティを指定します。

パラメータ名	タイプ	必須	説明
column_code	数値	必須	更新項目の項目コードを指定します。更新したい項目とは別に、更新対象のエンティティのプライマリーキーを設定してください。 ※下図のJson形式では「顧客コード:10001」「顧客コード:10002」を対象に、　それぞれの顧客名を更新しています。
text	文字列		テキスト型／テキストエリア型の項目の場合には、この属性に値を指定します。全角英数字を半角英数字に、機種依存文字/特殊文字を特定の文字に変換します。また、末尾のスペースを除去します。 ※変換ルールについては、オンラインヘルプPC版の「はじめに＞ご利用上の注意＞4 文字入力」を参照下さい。
date	日付または日時		日付／日時型の項目の場合には、この属性に値を指定します。
num	数値		整数型／セレクト型の項目の場合には、この属性に値を指定します。
checkbox	真偽値・配列		チェックボックス型の項目の場合には、この属性に値を指定します。
decimal	小数		小数型の項目の場合には、この属性に値を指定します。

JSON形式

[ { "objectName": "customer", "items": [ { "column_code": 301, "text": "顧客変更1" }, { "column_code": 318, "num": 10001 } ] }, { "objectName": "customer", "items": [ { "column_code": 301, "text": "顧客変更2" }, { "column_code": 318, "num": 10002 } ] } ]

Response

リソース要求が成功した場合は、複数のエンティティを更新します。

JSON形式

"primarykey" : [ xxxxx, xxxxx . . . ]

Example

curl -X PUT -H "Content-Type: application/json" -H "X-Auth-User-Token: yourusertoken" "https://<ホスト名>/<コンテキスト名>/rest/v1/entities"

DELETE /entities

Request

HTTP request

DELETE https://<ホスト名>[:<ポート番号>]/<コンテキスト名>/rest/v1/entities

Parameters

以下のプロパティを指定します。

パラメータ名	タイプ	必須	説明
objectName	文字列	必須	エンティティ名を指定します。
items	プロパティ名	必須	下記のitemsに記載されているプロパティを指定します。
bulkRelate	真偽値		true:関連情報を一括削除する、false:関連情報を一括削除しない ※未指定時は、関連情報を一括削除しません ※顧客エンティティのみ

items

以下のプロパティを指定します。

パラメータ名	タイプ	必須	説明
column_code	数値	必須	プライマリキーの項目コードを指定します。
num	数値	必須	プライマリキーが整数型／セレクト型の項目の場合には、この属性に値を指定します。 ※プライマリキーの型に合わせていずれかの属性に値を設定する
text	文字列	必須	プライマリキーがテキスト型／テキストエリア型の場合には、この属性に値を設定します。 ※プライマリキーの型に合わせていずれかの属性に値を設定する

JSON形式

例）customer(顧客)テーブルのレコードを2件削除する場合※プライマリキーが1つのケース

[ { "objectName": "customer", "items": [ { "column_code": 301, "num": 10001 } ] }, { "objectName": "customer", "items": [ { "column_code": 301, "num": 10002 } ] } ]

JSON形式

例）business_employee(自社担当者)テーブルのレコードを2件削除する場合※プライマリキーが複数あるケース

[ { "objectName": "business_employee", "items": [ { "column_code": -100, "num": 10001 }, { "column_code": -101, "num": 1 } ] }, { "objectName": "business_employee", "items": [ { "column_code": -100, "num": 10001 }, { "column_code": -101, "num": 2 } ] } ]

JSON形式

例）customer(顧客)テーブルのレコード2件を対象に関連情報も一括削除する場合※プライマリキーが1つのケース

[ { "objectName": "customer", "items": [ { "column_code": 301, "num": 10001 } ], "bulkRelate": true }, { "objectName": "customer", "items": [ { "column_code": 301, "num": 10002 } ], "bulkRelate": true } ]

Response

レスポンスは提供しません。

Example

curl -X DELETE -H "Content-Type: application/json" -H "X-Auth-User-Token: yourusertoken" -d 'yourjsondata' "https://<ホスト名>/<コンテキスト名>/rest/v1/entities"

GET /entity/file

Request

HTTP request

GET https://<ホスト名>[:<ポート番号>]/<コンテキスト名>/rest/v1/entity/file

Parameters

以下のプロパティを指定します。

パラメータ名	タイプ	必須	説明
obj	文字列	必須	エンティティ名を指定します。
id	文字列	必須	エンティティのコードを指定します。
columncode	文字列	必須	項目の項目コードを指定します。※活動のドキュメント項目の場合、125を指定してください。

Response

活動のドキュメント項目に登録されているファイルを取得します。

登録されているすべてのドキュメントのファイル名を「ファイルコード_ドキュメント名」に変更した上で、Zip化したファイルを返します。

拡張ファイル型項目に登録されているファイルを取得します。

パラメータ「columncode」に指定されているファイル型項目に登録されているファイルを返します。

Example

各シートの拡張ファイル型項目

curl -X GET -H "X-Auth-User-Token:yourusertoken" "https://<ホスト名>/<コンテキスト名>/rest/v1/entity/file?obj=customer&id=10001&columncode=<ファイル型項目の項目コード>" -o test.txt

活動のドキュメント項目

curl -X GET -H "X-Auth-User-Token:yourusertoken" "https://<ホスト名>/<コンテキスト名>/rest/v1/entity/file?obj=communication&id=10001&columncode=125" -o test.zip

POST /entity/file

Request

HTTP request

POST https://<ホスト名>[:<ポート番号>]/<コンテキスト名>/rest/v1/entity/file

※HTTPヘッダー「Content-Type」は「multipart/form-data」を利用することが必須となります。

Parameters

以下のプロパティを指定します。

パラメータ名	タイプ	必須	説明
obj	文字列	必須	エンティティ名を指定します。
id	文字列	必須	エンティティのコードを指定します。
columncode	文字列	必須	項目の項目コードを指定します。※活動のドキュメント項目の場合、125を指定してください。
foldercode	文字列	活動のドキュメントの場合のみ必須	文書フォルダコードを指定します。
file	ファイル	必須	ファイルを指定します。1GB未満のファイルを指定してください。

Response

リソース要求が成功した場合は、単一のエンティティを登録します。

JSON形式

"primarykey" : xxxxx

Example

各シートの拡張ファイル型項目

curl -X POST -H "Content-Type:multipart/form-data" -H "X-Auth-User-Token:yourusertoken" "https://<ホスト名>/<コンテキスト名>/rest/v1/entity/file?obj=customer&id=10001&columncode=<ファイル型項目の項目コード>" -F "file=@test.txt"

活動のドキュメント項目

curl -X POST -H "Content-Type:multipart/form-data" -H "X-Auth-User-Token:yourusertoken" "https://<ホスト名>/<コンテキスト名>/rest/v1/entity/file?obj=communication&id=100440&columncode=125&foldercode=<文書フォルダコード>" -F "file=@test.txt"

PUT /entity/file

Request

HTTP request

PUT https://<ホスト名>[:<ポート番号>]/<コンテキスト名>/rest/v1/entity/file

※HTTPヘッダー「Content-Type」は「multipart/form-data」を利用することが必須となります。

Parameters

以下のプロパティを指定します。

パラメータ名	タイプ	必須	説明
obj	文字列	必須	エンティティ名を指定します。
id	文字列	必須	エンティティのコードを指定します。
columncode	文字列	必須	項目の項目コードを指定します。※活動のドキュメント項目の場合、125を指定してください。
foldercode	文字列	活動のドキュメントの場合のみ必須	文書フォルダコードを指定します。
doccode	文字列	活動のドキュメントの場合のみ必須	ドキュメントコードを指定します。
file	ファイル	必須	ファイルを指定します。※1GB未満のファイルを指定してください。

Response

リソース要求が成功した場合は、単一のエンティティを更新します。

JSON形式

"primarykey" : xxxxx

Example

各シートの拡張ファイル型項目

curl -X PUT -H "Content-Type:multipart/form-data" -H "X-Auth-User-Token:yourusertoken" "https://<ホスト名>/<コンテキスト名>/rest/v1/entity/file?obj=customer&id=10001&columncode=<ファイル型項目の項目コード>" -F "file=@test変更.txt"

活動のドキュメント項目

curl -X PUT -H "Content-Type:multipart/form-data" -H "X-Auth-User-Token:yourusertoken" "https://<ホスト名>/<コンテキスト名>/rest/v1/entity/file?obj=communication&id=10001&columncode=125&foldercode=<文書フォルダコード>&doccode=<ドキュメントコード>" -F "file=@test変更.txt"

DELETE /entity/file

Request

HTTP request

DELETE https://<ホスト名>[:<ポート番号>]/<コンテキスト名>/rest/v1/entity/file

Parameters

以下のプロパティを指定します。

パラメータ名	タイプ	必須	説明
obj	文字列	必須	エンティティ名を指定します。
id	文字列	必須	エンティティのコードを指定します。
columncode	文字列	必須	項目の項目コードを指定します。※活動のドキュメント項目の場合、125を指定してください。
doccode	文字列	活動のドキュメントの場合のみ必須	ドキュメントコードを指定します。

Response

リソース要求が成功した場合は、単一のエンティティを削除します。

JSON形式

"primarykey" : xxxxx

Example

各シートの拡張ファイル型項目

curl -X DELETE -H "X-Auth-User-Token:yourusertoken" "https://<ホスト名>/<コンテキスト名>/rest/v1/entity/file?obj=customer&id=10001&columncode=<ファイル型項目の項目コード>"

活動のドキュメント項目

curl -X DELETE -H "X-Auth-User-Token:yourusertoken" "https://<ホスト名>/<コンテキスト名>/rest/v1/entity/file?obj=communication&id=10001&columncode=125&doccode=<ドキュメントコード>"