API Insights properties
Summarize
Summary of API Insights Properties
API Insights properties control the behavior of the application, allowing you to manage the import of various APIs and adjust system settings to optimize your experience. These properties can be accessed and modified through the System Properties [sysproperties] table.
Show less
Key Features
- Import Controls: Enable or disable the import of outbound REST and SOAP APIs, as well as scripted variants, from your ServiceNow instance.
- Machine Learning Settings: Specify minimum cluster quality for machine learning recommendations, with a default of 80.
- Search Limit: Set a limit on results for API and component searches, defaulting to 1000.
- Business Context Relationships: Define how APIs relate to business applications through a choice list.
- Access Workflow: Set the workflow ID for access requests in API Insights.
- Preferred Tools: Choose a preferred tool for API creation and set its URL, with defaults available.
- Support Group Representation: Specify the column in the Configuration Item table for support group representation in dashboards.
- Recommendations Display: Control visibility for clustering recommendations and metrics widgets on overview pages.
Key Outcomes
By effectively configuring these properties, you can tailor the API Insights experience to better fit your organization's needs, improve API management, and enhance visibility into API performance and usage. This allows for more informed decision-making and streamlined operations within your ServiceNow environment.
API Insights properties control the behavior of the application.
System properties
| Property | Description |
|---|---|
|
sn_api_insights_ws.import_outbound_rest_api |
Set the property to enable or disable the import of outbound REpresentational State Transfer (REST) APIs from your ServiceNow instance to the API Insights workspace.
|
|
sn_api_insights_ws.import_outbound_soap_api |
Set the property to enable or disable the import of outbound Simple Object Access Protocol Application Programming Interface (SOAP) APIs from your ServiceNow instance to the API Insights workspace.
|
|
sn_api_insights_ws.import_scripted_rest_api |
Set the property to enable or disable the import of scripted REST APIs from your ServiceNow instance to the API Insights workspace, and set the timeframe for recent activity.
|
|
sn_api_insights_ws.import_scripted_soap_api |
Set the property to enable or disable the import of scripted SOAP APIs from your ServiceNow instance to the API Insights workspace, and set the timeframe for recent activity.
|
|
sn_api_insights_ws.ml_min_cluster_quality |
Enter the minimum cluster quality to display in machine learning recommendations, ranging from 0 to 100.
|
|
sn_api_insights_ws.search_api_limit |
Enter the desired limit on results for API and API component searches.
|
|
sn_api_insights_ws.settings_api_to_business_app_service |
Set the property to the relationship model between APIs and business context.
|
|
sn_api_insights_ws.settings_grant_access_workflow |
Set the property to the sys ID of the workflow to be executed when an access request is submitted in API Insights.
|
|
sn_api_insights_ws.settings_preferred_tool |
Set the preferred tool for the creation of new APIs in API Insights.
|
|
sn_api_insights_ws.settings_preferred_tool_url |
Set the URL for the preferred API authoring tool inAPI Insights. This property value is used when the settings_preferred_tool property is set to API Authoring Tool.
|
|
sn_api_insights_ws.settings_support_group_column |
Set the column on the Configuration item [cmdb_ci] table that will represent the support group in the API Insights dashboards.
|
|
sn_api_insights_ws.show_ml_clustering_recs |
Set the property to false to disable the clustering recommendations for orphan API components.
|
|
sn_api_insights_ws.show_overview_metrics_widgets |
Set the property to true to enable showing the Metric Base widgets on the API and API Component Overview pages.
|