DealReportHistories : /API/v1/DealReportHistories
Venndor name
0000000000000_CyberPort(港湾物流分野)
System name
CyberPort
Infomation | |
Category |
|
Field |
|
Governments |
|
Data / Business logic |
|
Paid / Free |
Free |
Fees |
|
Created by |
|
Maintainer |
|
Date created |
|
Last updated |
|
Update frequency |
|
Necessity of contract |
Unnecessary |
About contract |
|
Version |
|
Terms and Conditions |
|
API List
API | Description | |
GET |
/API/v1/DealReportHistories/Compare/{dealReportHistoryId} |
取引・帳票履歴から、その時点での帳票データと、更新前の帳票データとの差分を取得します。
## 概要
取引と帳票は、作成や更新の履歴(履歴情報)を管理しており、その履歴情報には取引・帳票履歴ID(***dealReportHistoryId***)が設定されます。
履歴情報の操作種別が更新(***register***)の場合、その履歴(その時点)で更新された帳票データと、その更新前の帳票データとの差分を取得します。
例えば、ある取引内で以下の操作を行った場合、
1. 帳票:ブッキング依頼書(***BookingRequest***)の作成
2. 帳票:ブッキング依頼書(***BookingRequest***)の更新
*publisherCompanyName*に"あいうえお"を入力。
3. 帳票:ブッキング依頼書(***BookingRequest***)の更新
*publisherCompanyName*を"かきくけこ"に変更。
4. 帳票:ブッキング依頼書(***BookingRequest***)の更新
*publisherAddress*に"東京都千代田区"を入力
2.の時点の履歴情報の取引・帳票履歴ID(***dealReportHistoryId***)を指定して取得できる差分データは、1.との差分となります。(*publisherCompanyName*が"あいうえお"に変更)
3.の時点の履歴情報の取引・帳票履歴ID(***dealReportHistoryId***)を指定して取得できる差分データは、2.との差分となります。(*publisherCompanyName*が"かきくけこ"から"あいうえお"に変更)
4.の時点の履歴情報の取引・帳票履歴ID(***dealReportHistoryId***)を指定して取得できる差分データは、以下の通りです。(*publisherAddress*が"東京都千代田区"に変更)
## 指定するパラメタについて
### 取引・帳票履歴ID
差分データを取得する取引・帳票履歴の取引・帳票履歴ID(***dealReportHistoryId***)を指定します。
|
|
GET |
/API/v1/DealReportHistories/Get/{dealReportHistoryId} |
取引・帳票履歴を取得します。
## 概要
取引内の帳票は、更新前の状態を管理しており、その履歴には取引・帳票履歴ID(***dealReportHistoryId***)が設定されます。
このAPIでは、取引・帳票履歴IDを指定して、取引・帳票の更新履歴を取得します。
## 指定するパラメタについて
### 取引・帳票履歴ID
取得する取引・帳票履歴の取引・帳票履歴ID(***dealReportHistoryId***)を指定します。
|
|
GET |
/API/v1/DealReportHistories/GetCount?filter={filter} |
検索条件を指定して、条件に該当する取引・帳票履歴の件数を取得します。
## 概要
検索条件を指定して、条件に取引・帳票履歴する取引の件数を取得します。
検索条件の指定方法については、[こちらを参照ください](https://docs.microsoft.com/ja-jp/graph/query-parameters#filter-parameter)。
|
|
GET |
/API/v1/DealReportHistories/GetList?filter={filter}&orderby={orderby}&top={top} |
検索条件を指定して、条件に該当する取引・帳票履歴を全て取得します。
## 概要
検索条件を指定して、条件に該当する取引・帳票履歴を全て取得します。
検索条件の指定方法については、[こちらを参照ください](https://docs.microsoft.com/ja-jp/graph/query-parameters#filter-parameter)。
|
|
GET |
/API/v1/DealReportHistories/GetReportHistory/{dealReportHistoryId}?dealReportId={dealReportId} |
取引・帳票履歴から、その時点での過去の帳票データを取得します。
## 概要
取引・帳票履歴から、その時点での過去の帳票データを取得します。
## 指定するパラメタについて
### 取引・帳票履歴ID
取得する取引・帳票履歴の取引・帳票履歴ID(***dealReportHistoryId***)を指定します。
### 取引・帳票ID
過去のデータを取得する帳票の取引・帳票ID(***dealReportId***)を指定します。
|
|