Ab Version 2.x, iDNA Applications stellt eine externe API für die folgenden Szenarien bereit:

  • Mit der API können Sie Datenbank- und Replikat-Set-Informationen extrahieren, die von . gesammelt wurden iDNA Applications um es in anderen Anwendungen zu verwenden
  • Mit der API können Sie Datenbanken oder Replikatsätzen benutzerdefinierte Eigenschaften zuweisen oder aktualisieren, damit Sie sie innerhalb von . verwenden können iDNA Applications.


Postman

IFA API.postman_collection.json

Verwenden Sie die Postman-Auflistung, um die API-Aufrufe zu testen.

Beachten Sie, dass Sie die Host-Variable im Postman setzen müssen (unter Einstellungen → Umgebungen verwalten).

Die Autorisierungsheader in der Postman-Sammlung sind so konfiguriert, dass sie die mdapi Benutzer mit dem Passwort mdapi. Entweder müssen Sie einen Benutzer mit dieser Benutzername/Passwort-Kombination erstellen, wie im nächsten Abschnitt beschrieben, oder Sie müssen ihn basierend auf Ihrem bestehenden Benutzer aktualisieren.


Die externe API befindet sich unter https:/ /api/external/xxx


Genehmigung

Es wird ein Benutzer benötigt, der unter . angelegt werden kann https:/ /idna/sys/accounts

Bitte beachten Sie, dass Sie "API" aus der Dropdown-Liste Behörde auswählen müssen.


Um die API verwenden zu können, muss ein Autorisierungs-Header gesendet werden. Wir verwenden Basic Authentication, daher sollte der Header so aussehen:

Berechtigung: Basic base64encode (Benutzername:Passwort)

Wenn Ihre Anmeldeinformationen beispielsweise user:password sind, sollte die Kopfzeile wie folgt lauten:

  • Berechtigung: Basic dXNlcjpwYXNzd29yZA==


die API gibt 401 zurück, wenn

  • Es wird kein Autorisierungs-Header bereitgestellt
  • Benutzeranmeldeinformationen sind falsch
  • Die Benutzerberechtigung ist unzureichend


Datenbankinstanzen

BeschreibungURLNutzlast: XNUMX KgAntwortAntwort Json
Erhalten Sie eine Liste aller Datenbanken

BESTELLE {{host}}/api/extern/databases


Parameter:

mit dem Fokus auf - Boolean: Fokusdatenbanken filtern

z.B: {{host}}/api/external/databases?focus=true


-

Gibt ein Array von Datenbankobjekten mit grundlegenden Informationen zurück.
[ { "res_id": 469, "server_name": "server/panagenda", "file_name": "test/testlog.nsf", "title": "iDNAlog", "replicaid": "C1245D0E15534F18", "database_type": "Application", "size_bytes": "1290240", "is_focus_db": wahr } ]
Rufen Sie eine Liste aller Datenbanken mit benutzerdefinierten Eigenschaften ab

BESTELLE {{host}}/api/extern/databases/all/customProperties


Parameter:

resIds - string: durch Kommas getrennte Liste von res_id-Werten, die zur Auswahl bestimmter Datenbanken verwendet werden können


z.B: {{host}}/api/external/databases/all/customProperties?resIds=402,403,404

-Gibt ein Array von Datenbankobjekten mit benutzerdefinierten Eigenschaften zurück
{ "res_id": 330, "customProperties": { "ts": "2020-06-03T21:06:14.217848+00:00", "source": "web", "values": { "1001001": " Ruhend", "1001002": "Cher", "1001003": "Klassifizierung", "1001004": "Ja", "1001005": "Niedrig", "1001006": "435", "1001008": "Entwicklung" , "1001009": "Benutzer@panagenda.com", "1001010": "entwickler@panagenda.com", "1001011": "bekannte Schnittstellen", "1001012": "Mars", "1001013": "www.google.com", "1001014": 1593180000000, "1001020": "Kommentar" }, "Kommentar ": null, "modifier": "config" } },
Erhalten Sie eine Liste aller Datenbanken mit detaillierten Informationen

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


Parameter:

resIds - string: durch Kommas getrennte Liste von res_id-Werten, die zur Auswahl bestimmter Datenbanken verwendet werden können


z.B: {{host}}/api/external/databases/all/details?resIds=402,403,404

-Gibt ein Array von Datenbankobjekten mit detaillierten Informationen zurück (einschließlich benutzerdefinierter Eigenschaften)
 { "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, "similarity": null, "customProperties": { "ts": "2020-06-08T07:47:05.162921+00:00", "source": "external-api", "values": { "1001004": "Ja", "1001005": "Sehr hoch", "1001009": "NodeJs" }, "comment": null, "modifier": null } }

Replikationssets

BeschreibungURLNutzlast: XNUMX KgAntwortAntwort Json
Rufen Sie eine Liste aller Replikatsätze ab

BESTELLE {{host}}/api/extern/replicaSets


Parameter:

mit dem Fokus auf - Boolean: Fokusdatenbanken filtern

z.B: {{host}}/api/external/replicaSets?focus=true


-Gibt ein Array von Replikatsatzobjekten mit grundlegenden Informationen zurück
[ { "replicaid": "C14576C5113CCE73", "title": "", "server_names": [ "server/panagenda" ], "replicas_count": 1, "db_type_name": "System Database", "is_focus_db": false } ]
Rufen Sie eine Liste aller Replikatsätze mit benutzerdefinierten Eigenschaften ab

BESTELLE {{host}}/api/external/replicaSets/all/customProperties


Parameter:

replikids- string: durch Kommas getrennte Liste von Replikidwerten, die verwendet werden können, um bestimmte Replikatsätze auszuwählen


z.B: {{host}}/api/external/databases/all/customProperties?replicaIds=C2357E4B127EDE78,C23579AE0125A4B3,C2258814004555A9

-Gibt ein Array von Replikatsatzobjekten mit benutzerdefinierten Eigenschaften zurück
[ { "replicaid": "C14576C5113CCE73", "customProperties": { "ts": "2020-06-08T10:01:39.29916+00:00", "values": { "1002009": "Sehr hoch", " 1002012": "NodeJS" }, "comment": null, "modifier": null, "resource": "external-api" } } ]
Erhalten Sie eine Liste aller Replikat-Sets mit detaillierten Informationen

BESTELLE {{host}}/api/external/replicaSets/alle/Details


Parameter:

replikids- string: durch Kommas getrennte Liste von Replikidwerten, die verwendet werden können, um bestimmte Replikatsätze auszuwählen


z.B: {{host}}/api/external/databases/all/details?replicaIds=C2357E4B127EDE78,C23579AE0125A4B3,C2258814004555A9

-Gibt ein Array von Replikatsatzobjekten mit detaillierten Informationen zurück (einschließlich benutzerdefinierter Eigenschaften)
[ { "title": "", "replicaid": "C14576C5113CCE73", "db_type_id": 300, "db_type_name": "System Database", "is_focus_db": false, "design_collection_status": "Nicht erfasst", "design_collection_status_detail" : "Nicht gesammelt", "replicas_count": 1, "replicas_encrypted_count": 0, "server_names": [ "server/panagenda" ], "replica_paths": [ "server/panagenda!!filename.nsf" ], "server_adminserver": null, "categories": 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, "usage_category_simplified": "Nein / Niedrig", "usage_display_index": 0, "usage_all_time": "Keine Nutzung", "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": "Keine Nutzung", "user_access_days_last365d": 0, "users_active_last365d": 0, "days_active_last365d": 0, "sessions_last365d": 0, "sessions_web_last365" ": 0, "sessions_write_last365d": 0, "usage_last90d": "Keine Nutzung", "user_access_days_last90d": 0, "users_active_last90d": 0, "da ys_active_last90d": 0, "sessions_last90d": 0, "sessions_web_last90d": 0, "sessions_write_last90d": 0, "usage_last30d": "Keine Nutzung", "user_access_days_last30d": 0, "users_active_last30d": 0, "days_active_last30d": 0, "sessions_last30d": 0, "sessions_web_last30d": 0, "sessions_write_last30d": 0, "usage_last7d": "Keine Nutzung", "user_access_days_last7d": 0, "users_active_last7d": 0, "days_active_last7d": 0, "sessions_last7d": 0 , "sessions_web_last7d": 0, "sessions_write_last7d": 0, "documents_count_min": 48, "documents_count_avg": 48, "documents_count_max": 48, "size_mb_min": 67, "size_mb_avg": 67.5, "size_mb_max": 67, " design_complexity": "Nicht analysiert", "design_complexity_simplified": "Nicht analysiert", "design_complexity_score": null, "design_complexity_display_index": 0, "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_display, "remediation": null_display, "remediation": , "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, "replica_newest_design": "server/panagenda!!Dateiname.nsf", "database_id_oldest_design": 72, "replica_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_oldest_design": nulltemplate nullrank: nulltemplate nullranke: nulltemplate nulltemplate: nulltemplate_tois_similarity_oldest_design": nulltemplate 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_java_elements" : 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" : "Sehr hoch", "1002012": "NodeJS" }, "comment": null, "modifier": null, "resource": "external-api" } } ]

Benutzerdefinierte Eigenschaften

BeschreibungURLNutzlast: XNUMX KgAntwortAntwort Json
Alle benutzerdefinierten Eigenschaften abrufen

BESTELLE {{host}}/api/external/customProperties


Parameter:

tippe - string: kann verwendet werden, um nach benutzerdefinierten Eigenschaften der Datenbank ('db') oder des Replikatsatzes ('rs') zu filtern

z.B: 

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

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

-Gibt ein Array von benutzerdefinierten Eigenschaftsobjekten zurück
[ { "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 } ]

Benutzerdefinierte Eigenschaftszuweisungen

BeschreibungURLNutzlast: XNUMX KgAntwortAntwort Json
Weisen Sie y Datenbanken x benutzerdefinierte Eigenschaften zu

jetzt lesen {{Gastgeber}}/api/external/customPropertyAssignment/Datenbank


Headers:

Inhaltstyp: application/json


{ "targetIds": [402, 403, 404], "customProperties": { "1001009": "NodeJs", "1001005": "Sehr hoch" } }

Ziel-IDs - durch Kommas getrennte Liste der Datenbank res_id Werte

benutzerdefinierte Eigenschaften - ein Objekt mit Schlüssel/Wert-Paaren aus benutzerdefinierter Eigenschafts-ID und benutzerdefiniertem Eigenschaftswert

Aktualisiert - Ein Array erstellter / aktualisierter benutzerdefinierter Eigenschaften


error - Enthält Fehlerinformationen. zB wenn bestimmte targetIds nicht vorhanden sind

{ "updated": [ { "res_id": 402, "customProperties": { "ts": "2020-06-08T13:20:05.541693+00:00", "source": "external-api", "values ": { "1001004": "Ja", "1001005": "Sehr hoch", "1001009": "NodeJs" }, "comment": null, "modifier": null } }, { "res_id": 404, "customProperties": { "ts": "2020-06-08T13:20:05.541693+00:00", "source": "external-api", "values": { "1001004": "Ja", "1001005 ": "Sehr hoch", "1001009": "NodeJs" }, "comment": null, "modifier": null } }, { "res_id": 403, "customProperties": { "ts": "2020-06 -08T13:20:05.541693+00:00", "source": "external-api", "values": { "1001004": "Ja", "1001005": "Sehr hoch", "1001009": "NodeJs " }, "comment": null, "modifier": null } } ], "error": { "message": "Die folgenden Ressourcen wurden nicht aktualisiert, da die IDs nicht vorhanden sind", "notUpdated": [ 9999 ] } }
Zuweisen von x benutzerdefinierten Eigenschaften zu y Replikatsätzen

jetzt lesen {{Gastgeber}}/api/external/customPropertyAssignment/replicaSet


Headers:

Inhaltstyp: application/json

{ "targetIds": ["C2357E4B127EDE78", "C23579AE0035A477", "C2357714004455A9"], "customProperties": { "1001009": "NodeJs", "1001005": "Sehr hoch" } }

Ziel-IDs - Komma-separierte Liste von Replikatsätzen Replikat Werte

benutzerdefinierte Eigenschaften - ein Objekt mit Schlüssel/Wert-Paaren aus benutzerdefinierter Eigenschafts-ID und benutzerdefiniertem Eigenschaftswert

Aktualisiert - Ein Array erstellter / aktualisierter benutzerdefinierter Eigenschaften


error - Enthält Fehlerinformationen. zB wenn bestimmte targetIds nicht vorhanden sind

{ "updated": [ { "replicaid": "C2357E4B127EDE78", "customProperties": { "ts": "2020-06-08T13:24:37.128571+00:00", "values": { "1002009": " Very High", "1002012": "NodeJS" }, "comment": null, "modifier": null, "resource": "external-api" } }, { "replicaid": "C23579AE0035A477", "customProperties": { "ts": "2020-06-08T13:24:37.128571+00:00", "values": { "1002009": "Sehr hoch", "1002012": "NodeJS" }, "comment": null, "modifier": null, "resource": "external-api" } }, { "replicaid": "C2357714004455A9", "customProperties": { "ts": "2020-06-08T13:24:37.128571+00:00 ", "values": { "1002009": "Sehr hoch", "1002012": "NodeJS" }, "comment": null, "modifier": null, "resource": "external-api" } } ], "error": { "message": "Die folgenden Ressourcen wurden nicht aktualisiert, da die IDs nicht vorhanden sind", "notUpdated": [ "C1257E4B007EDEAA" ] } }