Descargas

Desde la versión 2.x en adelante, iDNA Applications proporciona una API externa para los siguientes escenarios:

  • Con la API, puede extraer la información de la base de datos y del conjunto de réplicas recopilada por iDNA Applications para usarlo en otras aplicaciones
  • Con la API, puede asignar o actualizar propiedades personalizadas a bases de datos o conjuntos de réplicas para que pueda usarlas dentro de iDNA Applications.


Cartero

IFA API.postman_collection.json

Utilice la colección Postman para probar las llamadas a la API.

Tenga en cuenta que debe configurar la variable host en el cartero (en configuración → administrar entornos).

Los encabezados de autorización en la colección de cartero están configurados para usar el mdapi usuario con la contraseña mdapi. O tendrá que crear un usuario con esta combinación de nombre de usuario/contraseña como se describe en la siguiente sección, o tendrá que actualizarlo en función de su usuario existente.


La API externa se encuentra en https:/ /api/externo/xxx


Autorización

Se requiere un usuario que se puede crear en https:/ /idna/sys/cuentas

Tenga en cuenta que debe seleccionar "API" en la lista desplegable Autoridad.


Para utilizar la API, se debe enviar un encabezado de autorización. Estamos utilizando la autenticación básica, por lo que el encabezado debería verse así:

Autorización: Base64encode básico (nombre de usuario: contraseña)

si sus credenciales son, por ejemplo, usuario: contraseña, entonces el encabezado debería ser:

  • Autorización: Básica dXNlcjpwYXNzd29yZA==


la API devuelve 401 si

  • No se proporciona encabezado de autorización
  • Las credenciales de usuario son incorrectas
  • La autoridad del usuario es insuficiente


Instancias de base de datos

DescripciónEnlancecarga útilRespuestaRespuesta Json
Obtener una lista de todas las bases de datos

{{host}}/api/externo/bases de datos


parámetros:

enfocarte - booleano: bases de datos de enfoque de filtro

p.ej: {{host}}/api/externo/bases de datos?focus=true


-

Devuelve una matriz de objetos de base de datos con información básica.
[ { "res_id": 469, "nombre_servidor": "servidor/panagenda", "file_name": "test/testlog.nsf", "title": "iDNAlog", "replicaid": "C1245D0E15534F18", "database_type": "Aplicación", "size_bytes": "1290240", "is_focus_db": cierto } ]
Obtenga una lista de todas las bases de datos con propiedades personalizadas

{{host}}/api/externo/bases de datos/todas/propiedades personalizadas


parámetros:

Resids - cadena: lista separada por comas de valores de res_id que se pueden usar para seleccionar bases de datos específicas


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

-Devuelve una matriz de objetos de base de datos con propiedades personalizadas
{ "res_id": 330, "customProperties": { "ts": "2020-06-03T21:06:14.217848+00:00", "fuente": "web", "valores": { "1001001": " Inactivo", "1001002": "Cher", "1001003": "clasificación", "1001004": "Sí", "1001005": "Bajo", "1001006": "435", "1001008": "Desarrollo" , "1001009": "usuario@panagenda.com", "1001010": "desarrollador@panagenda.com", "1001011": "interfaces conocidas", "1001012": "Mars", "1001013": "www.google.com", "1001014": 1593180000000, "1001020": "comentario" }, "comentario ": nulo, "modificador": "config" } },
Obtenga una lista de todas las bases de datos con información detallada

{{host}}/api/externo/bases de datos/todos/detalles


parámetros:

Resids - cadena: lista separada por comas de valores de res_id que se pueden usar para seleccionar bases de datos específicas


p.ej: {{host}}/api/externo/bases de datos/todos/detalles?resIds=402,403,404

-Devuelve una matriz de objetos de base de datos con información detallada (incluidas las propiedades personalizadas)
 { "uso": nulo, "vistas": nulo, "diseño": nulo, "res_id": 402, "catálogo": { "id": 402, "tamaño": 3932160, "tipo": 0, "título ": "Control de cambios de Domino (6)", "servidor": { "node_id": 6, "hostname": "test.somedomain.com", "data_path": "D:/Domino/Data", "exec_path" : "C:/Domino/Servidor/", "servidor_os": "Windows/2003 5.2 Intel Pentium", "nombreservidor": "servidor/panagenda", "nombre de clúster": nulo, "etiquetas_servidor": [ "panagenda" ], "versión_domino": "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": nulo, "similitud": nulo, "propiedades personalizadas": { "ts": "2020-06-08T07:47:05.162921+00:00", "fuente": "api externa", "valores": { "1001004": "Sí", "1001005": "Muy alto", "1001009": "NodeJs" }, "comentario": nulo, "modificador": nulo } }

ReplicaSets

DescripciónEnlancecarga útilRespuestaRespuesta Json
Obtener una lista de todos los conjuntos de réplicas

{{host}}/api/externo/replicaSets


parámetros:

enfocarte - booleano: bases de datos de enfoque de filtro

p.ej: {{host}}/api/external/replicaSets?focus=true


-Devuelve una matriz de objetos de conjunto de réplicas con información básica
[ { "replicaid": "C14576C5113CCE73", "título": "", "nombres_servidor": [ "servidor/panagenda" ], "replicas_count": 1, "db_type_name": "Base de datos del sistema", "is_focus_db": false } ]
Obtenga una lista de todos los conjuntos de réplicas con propiedades personalizadas

{{host}}/api/external/replicaSets/todas/propiedades personalizadas


parámetros:

replicaIds- string: lista separada por comas de valores de replicaid que se pueden usar para seleccionar conjuntos de réplicas específicos


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

-Devuelve una matriz de objetos de conjunto de réplicas con propiedades personalizadas
[ { "replicaid": "C14576C5113CCE73", "customProperties": { "ts": "2020-06-08T10:01:39.29916+00:00", "valores": { "1002009": "Muy alto", " 1002012": "NodeJS" }, "comentario": nulo, "modificador": nulo, "recurso": "api externo" } } ]
Obtenga una lista de todos los conjuntos de réplicas con información detallada

{{host}}/api/external/replicaSets/Todos los detalles


parámetros:

replicaIds- string: lista separada por comas de valores de replicaid que se pueden usar para seleccionar conjuntos de réplicas específicos


p.ej: {{host}}/api/externo/bases de datos/todos/detalles?replicaIds=C2357E4B127EDE78,C23579AE0125A4B3,C2258814004555A9

-Devuelve una matriz de objetos de conjunto de réplicas con información detallada (incluidas las propiedades personalizadas)
[ { "título": "", "replicaid": "C14576C5113CCE73", "db_type_id": 300, "db_type_name": "Base de datos del sistema", "is_focus_db": falso, "design_collection_status": "No recopilado", "design_collection_status_detail" : "No recopilado", "replicas_count": 1, "replicas_encrypted_count": 0, "server_names": [ "servidor/panagenda" ], "replica_paths": [ "servidor/panagenda!!filename.nsf" ], "server_adminserver": nulo, "categorías": nulo, "application_created_date": "2010-04-29", "application_lastmodified_date": "2020-06-06", "db_usage_history_start_date": nulo, "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 ": nulo, "usage_category_simplified": "No / Low", "usage_display_index": 0, "usage_all_time": "Sin uso", "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": "Sin uso", "user_access_days_last365d": 0, "users_active_last365d": 0, "days_active_last365d": 0, "sessions_last365d": 0, "sessions365web_last0 ": 365, "sessions_write_last0d": 90, "usage_last90d": "Sin uso", "user_access_days_last0d": 90, "users_active_last0d": 90, "da ys_active_last0d": 90, "sessions_last0d": 90, "sessions_web_last0d": 90, "sessions_write_last0d": 30, "usage_last30d": "Sin uso", "user_access_days_last0d": 30, "users_active_last0d": 30, "days_active_last0d": 30, "sessions_last0d": 30, "sessions_web_last0d": 30, "sessions_write_last0d": 7, "usage_last7d": "Sin uso", "user_access_days_last0d": 7, "users_active_last0d": 7, "days_active_last0d": 7, "sessions_last0d": 7 , "sessions_web_last0d": 7, "sessions_write_last0d": 48, "documents_count_min": 48, "documents_count_avg": 48, "documents_count_max": 67, "size_mb_min": 67.5, "size_mb_avg": 67, "size_mb_max": 0, " design_complexity": "No analizado", "design_complexity_simplified": "No analizado", "design_complexity_score": nulo, "design_complexity_display_index": XNUMX, "design_insights_score": nulo, "is_template_candidate": falso, "templates_inherits_from_count": 1, "templates_inherits_from": [ "StdR85Mail" ], "templates_acts_as_master_count": 0, "templates_acts_as_master": nulo, "remediation_classification": nulo, "remediation_display_index": nulo , "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": "servidor/panagenda!!filename.nsf", "database_id_oldest_design": 72, "replica_oldest_design": "servidor/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": null, "design_is_similar_to_standard_template": null, "template_similarity_ranking_list": null, "template_similarity_ranking_list": null, "template_similarity_ranking_list": design_cluster_ids": nulo, "database_id_design_reference": nulo, "design_formula_elements": nulo, "design_formula_loc": nulo, "design_lotusscript_elements": nulo, "design_lotusscript_loc": nulo, "design_javascript_elements": nulo, "design_javascript_loc": nulo, "design_java_elements" : nulo, "design_java_loc": nulo, "design_agents_elements": nulo, "design_agents_loc": nulo, "design_folders_elements": nulo, "design_folders_loc": nulo, "design_forms_elements": nulo, "design_forms_loc": nulo, "design_views_elements": nulo , "design_views_loc": nulo, "design_scriptlibraries_elements": nulo, "design_scriptlibraries_loc": nulo, "design_xpages_element s": nulo, "design_xpages_customcontrols": nulo, "mailin_names": nulo, "customProperties": { "ts": "2020-06-08T10:01:39.29916+00:00", "valores": { "1002009" : "Muy alto", "1002012": "NodeJS" }, "comentario": nulo, "modificador": nulo, "recurso": "api externo" } } ]

Propiedades personalizadas

DescripciónEnlancecarga útilRespuestaRespuesta Json
Obtener todas las propiedades personalizadas

{{host}}/api/external/customProperties


parámetros:

tipo - cadena: se puede usar para filtrar las propiedades personalizadas de la base de datos ('db') o del conjunto de réplicas ('rs')

p.ej: 

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

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

-Devuelve una matriz de objetos de propiedad personalizados.
[ { "tipo": "db", "id": 33, "nombre": "1241234", "metadata_tipo": "texto", "opciones": { "valores": [] }, "creado_por": " config", "descripción": nulo, "personalizado": verdadero, "habilitado": falso }, { "tipo": "rs", "id": 1002004, "nombre": "Atención VIP", "metadata_tipo": "uno de", "opciones": { "valores": [ "Sí", "No" ] }, "creado_por": "panagenda", "descripción": nulo, "personalizado": falso, "habilitado": verdadero } ]

Asignaciones de propiedades personalizadas

DescripciónEnlancecarga útilRespuestaRespuesta Json
Asigne x propiedades personalizadas a y bases de datos

PUBLICAR {{anfitrión}}/api/externo/asignación de propiedad personalizada/base de datos


Cabezales:

Tipo de contenido: aplicación/json


{ "targetIds": [402, 403, 404], "customProperties": { "1001009": "NodeJs", "1001005": "Muy alto" } }

ID de objetivo - lista separada por comas de la base de datos res_id valores

propiedades personalizadas - un objeto con pares clave/valor de ID de propiedad personalizada y valor de propiedad personalizada

actualizado - Una matriz de propiedades personalizadas creadas/actualizadas


error: contiene información de error. por ejemplo, si ciertos targetIds no existen

{ "actualizado": [ { "res_id": 402, "customProperties": { "ts": "2020-06-08T13:20:05.541693+00:00", "fuente": "api externa", "valores ": { "1001004": "Sí", "1001005": "Muy alto", "1001009": "NodeJs" }, "comentario": nulo, "modificador": nulo } }, { "res_id": 404, "customProperties": { "ts": "2020-06-08T13:20:05.541693+00:00", "fuente": "api externa", "valores": { "1001004": "Sí", "1001005 ": "Muy alto", "1001009": "NodeJs" }, "comentario": nulo, "modificador": nulo } }, { "res_id": 403, "customProperties": { "ts": "2020-06 -08T13:20:05.541693+00:00", "fuente": "api externa", "valores": { "1001004": "Sí", "1001005": "Muy alto", "1001009": "NodeJs " }, "comentario": nulo, "modificador": nulo } } ], "error": { "mensaje": "Los siguientes recursos no se actualizaron porque los identificadores no existen", "no actualizado": [ 9999 ] } }
Asigne x propiedades personalizadas a y conjuntos de réplicas

PUBLICAR {{anfitrión}}/api/external/customPropertyAssignment/replicaSet


Cabezales:

Tipo de contenido: aplicación/json

{ "targetIds": ["C2357E4B127EDE78", "C23579AE0035A477", "C2357714004455A9"], "customProperties": { "1001009": "NodeJs", "1001005": "Muy alto" } }

ID de objetivo - lista separada por comas de conjunto de réplicas réplica valores

propiedades personalizadas - un objeto con pares clave/valor de ID de propiedad personalizada y valor de propiedad personalizada

actualizado - Una matriz de propiedades personalizadas creadas/actualizadas


error: contiene información de error. por ejemplo, si ciertos targetIds no existen

{ "actualizado": [ { "replicaid": "C2357E4B127EDE78", "customProperties": { "ts": "2020-06-08T13:24:37.128571+00:00", "valores": { "1002009": " Muy alto", "1002012": "NodeJS" }, "comentario": nulo, "modificador": nulo, "recurso": "api externo" } }, { "replicaid": "C23579AE0035A477", "customProperties": { "ts": "2020-06-08T13:24:37.128571+00:00", "valores": { "1002009": "Muy alto", "1002012": "NodeJS" }, "comentario": nulo, "modificador": nulo, "recurso": "api externo" } }, { "replicaid": "C2357714004455A9", "customProperties": { "ts": "2020-06-08T13:24:37.128571+00:00 ", "valores": { "1002009": "Muy alto", "1002012": "NodeJS" }, "comentario": nulo, "modificador": nulo, "recurso": "api externo" } } ], "error": { "mensaje": "Los siguientes recursos no se actualizaron porque los id no existen", "notUpdated": [ "C1257E4B007EDEAA" ] } }

Más información

Visite panagenda iDNA Applications ¡en nuestra página web!