ダウンロード

verison 2.x以降、 iDNA Applications 次のシナリオの外部APIを提供します。

  • APIを使用すると、によって収集されたデータベースおよびレプリカセット情報を抽出できます。 iDNA Applications 他のアプリケーションで使用するには
  • APIを使用すると、カスタムプロパティをデータベースまたはレプリカセットに割り当てたり更新したりできるため、 iDNA Applications.


Postman

IFA API.postman_collection.json

Postmanコレクションを使用してAPI呼び出しをテストします。

postmanでホスト変数を設定する必要があることに注意してください（[設定]→[環境の管理]の下）。

postmanコレクションの認証ヘッダーは、 mdapi パスワードを持つユーザー mdapi。 次のセクションで説明するように、このユーザー名とパスワードの組み合わせでユーザーを作成するか、既存のユーザーに基づいてユーザーを更新する必要があります。


外部APIは下にあります https：/ / api / external / xxx


承認

下で作成できるユーザーが必要です https：/ / idna / sys / accounts

[権限]ドロップダウンリストから[API]を選択する必要があることに注意してください。


APIを使用するには、認証ヘッダーを送信する必要があります。 基本認証を使用しているため、ヘッダーは次のようになります。

認証：基本base64encode（ユーザー名：パスワード）

クレデンシャルがたとえばuser：passwordの場合、ヘッダーは次のようになります。

  • 承認：基本dXNlcjpwYXNzd29yZA ==


APIは401を返します

  • Authorizationヘッダーは提供されません
  • ユーザーの資格情報が間違っている
  • ユーザー権限が不十分です


データベースインスタンス

説明URLペイロードレスポンス応答Json
すべてのデータベースのリストを取得する

GET {{host}}/ api / external / databases


パラメーター：

フォーカス --boolean：フォーカスデータベースをフィルタリングします

例えば： {{host}}/ api / external / databases？focus = true


-

基本情報を含むデータベースオブジェクトの配列を返します。
[{"res_id"：469、 "server_name"： "server /panagenda"、" file_name "：" test / testlog.nsf "、" title "：" iDNAlog "、" reply "：" C1245D0E15534F18 "、" database_type "：" Application "、" size_bytes "：" 1290240 "、" is_focus_db "： true}]
カスタムプロパティを持つすべてのデータベースのリストを取得する

GET {{host}}/ api / external / databases /all / customProperties


パラメーター：

resId -文字列：特定のデータベースを選択するために使用できるres_id値のコンマ区切りリスト


例えば： {{host}}/ api / external / databases / all / customProperties？resIds = 402,403,404

-カスタムプロパティを持つデータベースオブジェクトの配列を返します
{"res_id"：330、 "customProperties"：{"ts"： "2020-06-03T21：06：14.217848 + 00：00"、 "source"： "web"、 "values"：{"1001001"： "休止状態」、「1001002」：「シェール」、「1001003」：「分類」、「1001004」：「はい」、「1001005」：「低」、「1001006」：「435」、「1001008」：「開発」 、 "1001009"： "user @panagenda.com "、" 1001010 "：" developer @panagenda.com "、" 1001011 "："既知のインターフェース "、" 1001012 "："火星 "、" 1001013 "：" www.google.com "、" 1001014 "：1593180000000、" 1001020 "："コメント "}、"コメント"：null、"修飾子 "：" config "}}、
詳細情報を含むすべてのデータベースのリストを取得します

GET {{host}}/ api / external / databases / all / details


計測パラメータ:

resId -文字列：特定のデータベースを選択するために使用できるres_id値のコンマ区切りリスト


例えば： {{host}}/ api / external / databases / all / details？resIds = 402,403,404

-詳細情報（カスタムプロパティを含む）を含むデータベースオブジェクトの配列を返します
 {"usage"：null、 "views"：null、 "design"：null、 "res_id"：402、 "catalog"：{"id"：402、 "size"：3932160、 "type"：0、 "title "：" Domino Change Control（6） "、" server "：{" node_id "：6、" hostname "：" test.somedomain.com "、" data_path "：" D：/ Domino / Data "、" exec_path " ： "C：/ Domino / Server /"、 "server_os"： "Windows / 2003 5.2 Intel Pentium"、 "servername"： "server /panagenda"、" clustername "：null、" server_tags "：["panagenda"]、" domino_version "："Release 8.5.3FP6 HF646",
                "collection_active": true,
                "domino_buildnumber": "390",
                "max_collection_date": "2020-05-11",
                "min_collection_date": "2016-06-12",
                "server_architecture": "32 Bit",
                "tasks_running_count": 15,
                "server_access_status": 0
            },
            "created": 1089210821000,
            "size_mb": 3.8,
            "filename": "filename.ntf",
            "licensed": true,
            "modified": 1591521362406.52,
            "best_type": null,
            "replicaid": "85256AE30062503A",
            "sizequota": 0,
            "act_period": 3009,
            "categories": null,
            "in_catalog": true,
            "odsversion": null,
            "volumename": "D",
            "act_dayuses": 0,
            "is_focus_db": false,
            "percentused": 0,
            "sizewarning": 0,
            "storagepath": "D:\\Domino\\Data\\filename.ntf",
            "act_dayreads": 0,
            "act_weekuses": 0,
            "created_date": "2004-07-07",
            "lastmodified": 1588998889000,
            "templatename": "DominoChangeControl",
            "act_daywrites": 0,
            "act_monthuses": 1,
            "act_weekreads": 0,
            "documentcount": 78,
            "acl_adminnames": false,
            "act_monthreads": 0,
            "act_perioduses": 80,
            "act_weekwrites": 0,
            "count_replicas": 13,
            "filename_lower": "domchange.ntf",
            "in_dbdirectory": true,
            "server_node_id": 6,
            "type_on_server": 300,
            "act_monthwrites": 14,
            "act_periodreads": 0,
            "design_modified": 1397774744000,
            "fulltextindexed": false,
            "identified_type": 300,
            "listindbcatalog": true,
            "acl_author_count": 0,
            "acl_editor_count": 0,
            "acl_reader_count": 1,
            "act_periodwrites": 1082,
            "cat_doc_modified": 1591140117000,
            "created_datetime": "2004-07-07T14:33:41+00:00",
            "idna_instance_id": 6699374546818320000,
            "log_doc_modified": 1591498842000,
            "acl_manager_count": 4,
            "inmultidbindexing": false,
            "acl_designer_count": 0,
            "acl_noaccess_count": 5,
            "designtemplatename": null,
            "acl_depositor_count": 0,
            "design_num_documents": 182,
            "replication_disabled": false,
            "replication_priority": 2,
            "is_template_candidate": true,
            "acl_defaultaccesslevel": 2,
            "db_usage_history_start": null,
            "db_usage_history_until": null,
            "idna_domino_catalog_id": 7862820,
            "design_collection_state": "Not Collected",
            "acl_administrationserver": null,
            "acl_anonymousaccesslevel": 0,
            "best_type_server_node_id": null,
            "created_catalog_datetime": "2004-07-07T14:33:41+00:00",
            "replication_cutoffdelete": false,
            "replication_ignoredeletes": true,
            "db_usage_history_available": false,
            "replication_cutoffinterval": 0,
            "server_max_collection_date": "2020-05-11",
            "server_min_collection_date": "2016-06-12",
            "replication_receivesummaries": false,
            "replication_sendtitleandcatalog": true,
            "desgin_minimum_addedtofile_datetime": null,
            "usage_collection_log_sessions_start": 1465689600000,
            "usage_collection_log_sessions_until": 1589155200000
        },
        "insights"：null、"類似性 "：null、" customProperties "：{" ts "：" 2020-06-08T07：47：05.162921 + 00：00 "、" source "：" external-api "、" values "：{ "1001004"： "はい"、 "1001005"： "非常に高い"、 "1001009"： "NodeJs"}、 "コメント"：null、 "修飾子"：null}}

レプリカセット

説明URLペイロードレスポンス応答Json
すべてのレプリカセットのリストを取得します

GET {{host}}/ api / external / replyaSets


パラメーター：

フォーカス --boolean：フォーカスデータベースをフィルタリングします

例えば： {{host}}/ api / external / replyaceSets？focus = true


-基本情報を含むレプリカセットオブジェクトの配列を返します
[{"replicaid"： "C14576C5113CCE73"、 "title"： ""、 "server_names"：["server /panagenda"]、" replys_count "：1、" db_type_name "："システムデータベース "、" is_focus_db "：false}]
カスタムプロパティを持つすべてのレプリカセットのリストを取得します

GET {{host}}/ api / external / replyaceSets /all / customProperties


パラメーター：

ReplicaIds-文字列：特定のレプリカセットを選択するために使用できるレプリカID値のコンマ区切りリスト


例えば： {{host}}/api/external/databases/all/customProperties?replicaIds=C2357E4B127EDE78,C23579AE0125A4B3,C2258814004555A9

-カスタムプロパティを持つレプリカセットオブジェクトの配列を返します
[{"replicaid"： "C14576C5113CCE73"、 "customProperties"：{"ts"： "2020-06-08T10：01：39.29916 + 00：00"、 "values"：{"1002009"： "Very High"、 " 1002012 "：" NodeJS "}、"コメント "：null、"修飾子 "：null、"リソース "："外部API "}}]
詳細情報を含むすべてのレプリカセットのリストを取得します

GET {{host}}/ api / external / replyaceSets /すべて/詳細


パラメーター：

ReplicaIds-文字列：特定のレプリカセットを選択するために使用できるレプリカID値のコンマ区切りリスト


例えば： {{host}}/ api / external / databases / all / details？replicaIds =C2357E4B127EDE78,C23579AE0125A4B3,C2258814004555A9

-詳細情報（カスタムプロパティを含む）を含むレプリカセットオブジェクトの配列を返します
[{"title"： ""、 "replicaid"： "C14576C5113CCE73"、 "db_type_id"：300、 "db_type_name"： "システムデータベース"、 "is_focus_db"：false、 "design_collection_status"： "収集されていません"、 "design_collection_status_detail" ： "収集されていません"、 "replicas_count"：1、 "replicas_encrypted_count"：0、 "server_names"：["server /panagenda"]、" reply_paths "：[" server /panagenda!! filename.nsf "]、" server_adminserver "：null、" category "：null、" application_created_date "：" 2010-04-29 "、" application_lastmodified_date "：" 2020-06-06 "、" db_usage_history_start_date "：null、 "usage_collection_log_sessions_start_date"： "2017-03-08"、 "usage_collection_log_sessions_until_date"： "2020-05-29"、 "last_accessed"：null、 "last_accessed_user"：null、 "last_accessed_on_server"：null、 "last_write_access"：null、 "last_write_user "：null、" usersage_category_simplified "：" No / Low "、" usersage_display_index "：0、" usage_all_time "：" No Usage "、" user_access_days_all_time "：0、" users_active_all_time "：0、" days_active_all_time "：0、" sessions_all_time " ：0、 "sessions_web_all_time"：0、 "sessions_write_all_time"：0、 "usage_last365d"： "使用なし"、 "user_access_days_last365d"：0、 "users_active_last365d"：0、 "days_active_last365d"：0、 "sessions_last365d"：0、 "sessions_ "：365"、 "sessions_write_last0d"：365、 "usage_last0d"： "使用なし"、 "user_access_days_last90d"：90、 "users_active_last0d"：90、 "da ys_active_last0d "：90、" sessions_last0d "：90、" sessions_web_last0d "：90、" sessions_write_last0d "：90、" usersage_last0d "：" No Usage "、" user_access_days_last30d "：30、" users_active_last0d "：30、" days_active_last "sessions_last0d"：30、 "sessions_web_last0d"：30、 "sessions_write_last0d"：30、 "usage_last0d"： "使用なし"、 "user_access_days_last30d"：0、 "users_active_last7d"：7、 "days_active_last0d"：7、 "sessions_last0d 、 "sessions_web_last7d"：0、 "sessions_write_last7d"：0、 "documents_count_min"：7、 "documents_count_avg"：0、 "documents_count_max"：7、 "size_mb_min"：0、 "size_mb_avg"：48、 "size_mb_max"：48、 " design_complexity "："未分析 "、" design_complexity_simplified "："未分析 "、" design_complexity_score "：null、" design_complexity_display_index "：48、" design_insights_score "：null、" is_template_candidate "：false、" templates_inherits_from_count "：1、" templates_inherits_from "：[" StdR85Mail "]、" templates_acts_as_master_count "：0"、 "templates_acts_as_master"：null、 "remediation_classification"：null、 "remediation_classification" _ 、 "design_consistency"： "OK"、 "design_age_difference_hours"：0、 "design_modified_newest_design"： "2015-11-10T00：00：57 + 00：00"、 "design_modified_oldest_design"： "2015-11-10T00：00：57 + 00:00 "、" database_id_newest_design "：72、" reply_newest_design "：" server /panagenda!! filename.nsf "、" database_id_oldest_design "：72、" reply_oldest_design "：" server /panagenda!! filename.nsf "、" most_similar_template_name_newest_design "：null、" most_similar_template_similarity_newest_design "：null、" most_similar_template_name_oldest_design "：null、" most_similar_template_similarity_standard_ design_cluster_ids "：null、" database_id_design_reference "：null、" design_formula_elements "：null、" design_formula_loc "：null、" design_lotusscript_elements "：null、" design_lotusscript_loc "：null、" design_javascript_elements "：null、" design_javascript_loc "：null、" design_ ：null、 "design_java_loc"：null、 "design_agents_elements"：null、 "design_agents_loc"：null、 "design_folders_elements"：null、 "design_folders_loc"：null、 "design_forms_elements"：null、 "design_forms_loc"：null、 "design_views_elements"：null 、 "design_views_loc"：null、 "design_scriptlibraries_elements"：null、 "design_scriptlibraries_loc"：null、 "design_xpages_element s "：null、" design_xpages_customcontrols "：null、" mailin_names "：null、" customProperties "：{" ts "：" 2020-06-08T10：01：39.29916 + 00：00 "、" values "：{" 1002009 " ： "Very High"、 "1002012"： "NodeJS"}、 "comment"：null、 "modifier"：null、 "resource"： "external-api"}}]

カスタムプロパティ

説明URLペイロードレスポンス応答Json
すべてのカスタムプロパティを取得する

GET {{host}}/ api / external / customProperties


計測パラメータ:

type -文字列：データベース（ 'db'）またはレプリカセット（ 'rs'）のカスタムプロパティをフィルタリングするために使用できます

例えば： 

{{host}} / api / external / customProperties？type = rs

{{host}} / api / external / customProperties？type = db

-カスタムプロパティオブジェクトの配列を返します
[{"type"： "db"、 "id"：33、 "name"： "1241234"、 "metadata_type"： "text"、 "options"：{"values"：[]}、 "created_by"： " config "、" description "：null、" custom "：true、" enabled "：false}、{" type "：" rs "、" id "：1002004、" name "：" VIP Attention "、" metadata_type "： "oneof"、 "options"：{"values"：["Yes"、 "No"]}、 "created_by"： "panagenda"、" description "：null、" custom "：false、" enabled "：true}]

カスタムプロパティの割り当て

説明URLペイロードレスポンス応答Json
x個のカスタムプロパティをy個のデータベースに割り当てます

POST {{亭主}}/api / external / customPropertyAssignment / database


ヘッダ:

コンテンツタイプ：application / json


{"targetIds"：[402、403、404]、 "customProperties"：{"1001009"： "NodeJs"、 "1001005"： "非常に高い"}}

ターゲット ID -データベースのコンマ区切りリスト res_id 値

カスタムプロパティ -カスタムプロパティIDとカスタムプロパティ値のキー/値ペアを持つオブジェクト

更新しました - 作成/更新されたカスタムプロパティの配列


error-エラー情報が含まれています。 たとえば、特定のtargetIdが存在しない場合

{"updated"：[{"res_id"：402、 "customProperties"：{"ts"： "2020-06-08T13：20：05.541693 + 00：00"、 "source"： "external-api"、 "values "：{" 1001004 "："はい "、" 1001005 "："非常に高い "、" 1001009 "：" NodeJs "}、"コメント "：null、"修飾子 "：null}}、{" res_id "：404、 "customProperties"：{"ts"： "2020-06-08T13：20：05.541693 + 00：00"、 "source"： "external-api"、 "values"：{"1001004"： "Yes"、 "1001005 "："非常に高い "、" 1001009 "：" NodeJs "}、"コメント "：null、"修飾子 "：null}}、{" res_id "：403、" customProperties "：{" ts "：" 2020-06 -08T13：20：05.541693 + 00：00 "、" source "：" external-api "、" values "：{" 1001004 "：" Yes "、" 1001005 "：" Very High "、" 1001009 "：" NodeJs "}、"コメント "：null、"モディファイア "：null}}]、"エラー "：{"メッセージ "：" IDが存在しないため、次のリソースは更新されませんでした "、" notUpdated "：[9999]} }
x個のカスタムプロパティをy個のレプリカセットに割り当てます

POST {{亭主}}/api / external / customPropertyAssignment / ReplicaSet


ヘッダ:

コンテンツタイプ：application / json

{"targetIds"：["C2357E4B127EDE78"、 "C23579AE0035A477"、 "C2357714004455A9"]、 "customProperties"：{"1001009"： "NodeJs"、 "1001005"： "非常に高い"}}

ターゲット ID -レプリカセットのコンマ区切りリスト レプリカイド 値

カスタムプロパティ -カスタムプロパティIDとカスタムプロパティ値のキー/値ペアを持つオブジェクト

更新しました - 作成/更新されたカスタムプロパティの配列


error-エラー情報が含まれています。 たとえば、特定のtargetIdが存在しない場合

{"updated"：[{"replicaid"： "C2357E4B127EDE78"、 "customProperties"：{"ts"： "2020-06-08T13：24：37.128571 + 00：00"、 "values"：{"1002009"： "非常に高い "、" 1002012 "：" NodeJS "}、"コメント "：null、"修飾子 "：null、"リソース "："外部-api "}}、{"レプリカイド "：" C23579AE0035A477 "、" customProperties "： {"ts"： "2020-06-08T13：24：37.128571 + 00：00"、 "values"：{"1002009"： "Very High"、 "1002012"： "NodeJS"}、 "comment"：null、 "modifier"：null、 "resource"： "external-api"}}、{"replicaid"： "C2357714004455A9"、 "customProperties"：{"ts"： "2020-06-08T13：24：37.128571 + 00：00 "、" values "：{" 1002009 "：" Very High "、" 1002012 "：" NodeJS "}、" comment "：null、" modifyh "：null、" resource "：" external-api "}}]、 "エラー"：{"メッセージ"： "IDが存在しないため、次のリソースは更新されませんでした"、 "notUpdated"：["C1257E4B007EDEAA"]}}

サポート問い合わせ先

訪問 panagenda iDNA Applications 私たちのウェブサイトで！