RESTクライアントAPIに対するデータハブ拡張
このページでは、MarkLogicのRESTクライアントAPIを拡張するデータハブ RESTクライアントAPIのリストを紹介します。
フロー管理
mlRunFlow (POST)
指定したレコードを処理するためのフロー全体 、またはフロー内の単一ステップを実行するRESTクライアントAPI拡張機能です。
POST /v1/resources/mlRunFlow?rs:job-id=YourJobID&rs:flow-name=YourFlowName&rs:step=1&database=YourSourceDatabase&rs:target-database=YourTargetDatabase&rs:options={"uris":["comma-separated","uris","of","records","to","process"]}
- rs:job-id
- このフローの実行に対応付けられた一意のジョブID。このオプションは、フローの実行がより大きなプロセスの一部である場合に使用できます(例えば、NiFiが独自のジョブ/プロセスIDによりオーケストレーションしたプロセスなど)。既存のデータハブのジョブIDと同じにすることはできません。指定していない場合は、一意のデータハブジョブIDが割り当てられます。
- rs:flow-name
- フローの名前です。
- rs:step
- 実行するステップのシーケンス番号。特定のステップを複数実行するには、オーケストレーションツールを使用して、ステップごとに1つのrunFlowリクエストを送信します。
- database
- ソースデータを含むデータベース(例:data-hub-STAGING)。
- rs:target-database
- 処理済みのデータを保存するデータベース(例:data-hub-FINAL)。
- rs:options
- フローに渡す追加オプションを含むJSONオブジェクト。
- 処理するレコードのリストを指定するには、処理するレコードのURIの配列を値として含むキーurisを追加します。
レコード管理
MarkLogicデータハブは、フローを実行しなくてもレコードのマッチおよびマージ/アンマージをプログラム的に行える、RESTクライアントAPI拡張を提供しています。
mlSmMatch (POST)
あるレコードと他のレコードと比較し、マッチの可能性があるもののリストを返します。
POST /v1/resources/mlSmMatch?rs:uri=URIofFocusRecord&rs:flowName=YourFlowName&rs:step=1&rs:includeMatchDetails=[true|false]
- rs:uri
- (必須)他のレコードと比較されるレコードのURI。
- rs:flowName
- (必須)マスタリングステップを含むフローの名前。
- rs:step
- 指定されたフロー内のマスタリングステップのステップ番号。このタスクでは、マスタリングステップ内の設定を使用します。デフォルトは1です。つまりフロー内の最初のステップがマスタリングステップだということです。
- rs:includeMatchDetails
true
の場合、ポジティブなマッチのそれぞれに関する追加情報が提供されます。デフォルトは、false
です。
mlSmMerge (POST)
指定されたマスタリングステップの設定に基づき、指定されたレコードをマージします。
POST /v1/resources/mlSmMerge?rs:uri=URI1&rs:uri=URI2&rs:uri=URIn&rs:flowName=YourFlowName&rs:step=1&rs:preview=[true|false]
- rs:uri
- (必須)マージするレコードのURI。少なくとも2つ以上のURIを指定する必要があります。
- rs:flowName
- (必須)マスタリングステップを含むフローの名前。
- rs:step
- 指定されたフロー内のマスタリングステップのステップ番号。このタスクでは、マスタリングステップ内の設定を使用します。デフォルトは1です。つまりフロー内の最初のステップがマスタリングステップだということです。
- rs:preview
true
の場合、データベースには何も変更が加えられず、マージ済みレコードがシミュレーションとして返されます。それ以外の場合は、マージ済みレコードがデータベースに保存されます。デフォルトは、false
です。
mlSmMerge (DELETE)
指定されたマージ済みレコードを作成した一連のマージをリバースします。
DELETE /v1/resources/mlSmMerge?rs:mergeURI=URIofMergedRecord&rs:retainAuditTrail=[true|false]&rs:blockFutureMerges=[true|false]
- rs:mergeURI
- (必須)アンマージするレコードのURI。
- rs:retainAuditTrail
true
の場合、マージ済みレコードはアーカイブコレクションに移動されます。それ以外の場合は、削除されます。デフォルトは、true
です。- rs:blockFutureMerges
true
の場合、コンポーネント(マージ元)のレコードは再度マージされることがなくなります。デフォルトは、true
です。
注:このタスクでは、指定されたマージ済みレコードをアーカイブ化あるいは削除します。またこれを作成するために組み合わされたコンポーネント(マージ元)のレコードはアーカイブされなくなります。コンポーネントレコードの1つがマージ済みレコードである場合、コンポーネントレコードはそのままになります。
mlSmNotifications (GET)
マージのしきい値に近いが超えてはいないマッチに関する通知のリストを返します。
GET /v1/resources/mlSmNotifications?rs:start=1&rs:pageLength=10
- rs:start
- 返される最初の通知のインデックスです。
- rs:pageLength
- 返される通知の数です。
mlSmHistoryDocument (GET)
指定されたマージ済みレコードのドキュメントレベルの出自を返します。
GET /v1/resources/mlSmHistoryDocument?rs:uri=URIofMergedRecord
- rs:uri
- (必須)マージ済みレコードのURI。
mlSmHistoryProperties (GET)
マージ済みレコードの指定されたプロパティあるいはすべてのプロパティの履歴を返します。
GET /v1/resources/mlSmHistoryProperties?rs:uri=URIofMergedRecord&rs:property=YourPropertyName
- rs:uri
- (必須)マージ済みレコードのURI。
- rs:property
- 特定のプロパティの名前です。デフォルトは、すべてのプロパティが対象です。
注:デフォルトでは、ドキュメントレベルの出自しかトラッキングされません。プロパティレベルの出自をトラッキングする場合は、
"provenanceGranularityLevel" : "fine"
と設定してください。詳細は、「手作業による出自の粒度の設定」を参照してください。