データハブ RESTクライアントAPIに対するデータハブ拡張

このページでは、MarkLogicのRESTクライアントAPIを拡張するデータハブRESTクライアントAPIのリストを紹介します。

管理

mlHubversion (GET)

MarkLogicサーバーインスタンスにインストールしたデータハブのバージョンを返します。

GET /v1/resources/mlHubversion
mlDebug (GET)

MarkLogicサーバーインスタンスのデータハブにおいて、デバッグが現在オンになっている場合はtrueです。それ以外の場合は、falseです。

GET /v1/resources/mlDebug
mlDebug (POST)

POST /v1/resources/mlDebug?rs:enable=[true|false]
rs:enable
（必須）trueの場合、MarkLogicサーバーインスタンスのデータハブのデバッグがオンになります。それ以外の場合は、デバッグはオフとなります。デフォルトはfalseです。

フロー管理

hubCollector (GET)

GET /v1/resources/hubCollector?rs:flow-name=YourFlowName&rs:step=1&rs:database=FINAL-database&rs:options={}
rs:flow-name
（必須）フローの名前。
rs:step
（必須）Source CollectionあるいはSource Queryを指定するステップのシーケンス番号。
rs:database
検索の対象となるデータベースの名前。デフォルトはステップ内で指定されたソースデータベースです。
rs:options
追加オプションを含むJSONオブジェクト。
mlRunFlow (POST)

指定されたレコードを処理するためのフロー内のステップを実行します。

POST /v1/resources/mlRunFlow?rs:job-id=YourJobID&rs:flow-name=YourFlowName&rs:step=1&rs:options={"uris":["comma-separated","uris","of","records","to","process"]}
rs:job-id
このフローの実行に対応付けられた一意のジョブID。このオプションは、フローの実行がより大きなプロセスの一部である場合に使用できます（例えば、NiFiが独自のジョブ/プロセスIDによりオーケストレーションしたプロセスなど）。既存のデータハブのジョブIDと同じにすることはできません。指定していない場合は、一意のデータハブジョブIDが割り当てられます。
rs:flow-name
フローの名前です。
rs:step
実行するステップのシーケンス番号。特定のステップを複数実行するには、オーケストレーションツールを使用して、ステップごとに1つのmlRunFlowリクエストを送信します。
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:start=1&rs:pageLength=10
rs:uri
（必須）他のレコードと比較されるレコードのURI。
rs:flowName
（必須） マスタリングステップを含むフローの名前。
rs:step
指定されたフロー内のマスタリングステップのステップ番号。このタスクでは、マスタリングステップ内の設定を使用します。デフォルトは1です。つまりフロー内の最初のステップがマスタリングステップです。
rs:includeMatchDetails
trueの場合、ポジティブなマッチのそれぞれに関する追加情報が提供されます。デフォルトはfalseです。
rs:start
返される最初の通知のインデックスです。デフォルトは1です。
rs:pageLength
返される通知の数です。デフォルトは20です。
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
返される最初の通知のインデックスです。デフォルトは1です。
rs:pageLength
返される通知の数です。デフォルトは10です。
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".詳細は、「手作業による出自の粒度の設定」を参照してください。

ジョブ管理

mlJobs (GET)

指定されたパラメータに基づきジョブ情報を返します。

GET /v1/resources/mlJobs?rs:job-id=YourJobID&rs:status=&rs:flowNames=YourFlowName&rs:flow-name=YourFlowName
rs:job-id
このフローの実行に対応付けられた一意のジョブID。このオプションは、フローの実行がより大きなプロセスの一部である場合に使用できます（例えば、NiFiが独自のジョブ/プロセスIDによりオーケストレーションしたプロセスなど）。既存のデータハブのジョブIDと同じにすることはできません。指定していない場合は、一意のデータハブジョブIDが割り当てられます。 指定されたジョブIDに関連するジョブドキュメントを返すのに使用されます。 jobIDあるいはstatusのいずれかを指定可能です（両方は指定できません）。
rs:status
ジョブのステータスは以下のようになります。started、finished、finished_with_errors、running、failed、stop-on-error、canceled。指定されたステータスのあらゆるジョブに関連するジョブドキュメントのリストを返すのに使用されます。 jobIDあるいはstatusのいずれかを指定可能です（両方は指定できません）。
rs:flowNames
フローの名前です。指定されたフロー名を含む最後の実行のジョブIDおよびジョブ情報を返すのに使用されます。フロー名を追加して指定するには、このパラメータを繰り返します。
rs:flow-name
フローの名前です。指定されたフロー名を含むあらゆる実行に関連するジョブドキュメントのリストを返すのに使用されます。
mlBatches (GET)

指定されたステップあるいは指定されたジョブ内のバッチの対象となるバッチドキュメントを返します。

GET /v1/resources/mlBatches?rs:jobid=YourJobID&rs:step=1&rs:batchid=YourBatchID
rs:jobid
（必須） このフローの実行に対応付けられた一意のジョブID。このオプションは、フローの実行がより大きなプロセスの一部である場合に使用できます（例えば、NiFiが独自のジョブ/プロセスIDによりオーケストレーションしたプロセスなど）。既存のデータハブのジョブIDと同じにすることはできません。指定していない場合は、一意のデータハブジョブIDが割り当てられます。
rs:step
（必須）バッチドキュメントを返すステップのシーケンス番号。 stepあるいはbatchIdのいずれかを必ず指定する必要があります（両方は指定できません）。
rs:batchid
（必須）ドキュメントを返すバッチのID。 stepあるいはbatchIdのいずれかを必ず指定する必要があります（両方は指定できません）。