{ "openapi":"3.0.0", "info":{ "title":"REST API for Unified Assurance Core", "description":"The REST API for Oracle Communications Unified Assurance Core lets you manage components of Unified Assurance.", "version":"2026.04.16", "x-summary":"The REST API for Oracle Communications Unified Assurance Core lets you manage components of Unified Assurance." }, "tags":[ { "name":"AAA/Authentication Types", "description":"Use for managing authentication types." }, { "name":"AAA/Permissions", "description":"Use for managing permissions, primarily for custom packages. Roles are assigned permissions so the related groups and users can access the UIs and APIs." }, { "name":"AAA/Preferences", "description":"Use for managing preferences assigned to users or user groups. Preferences typically handle default settings like theme or page size." }, { "name":"AAA/Roles", "description":"Use for managing roles." }, { "name":"AAA/Tenants", "description":"Use for managing tenants." }, { "name":"AAA/User Group Properties", "description":"Use for managing user group properties." }, { "name":"AAA/User Groups", "description":"Use for managing user groups." }, { "name":"AAA/User Profiles", "description":"Use for managing user profiles." }, { "name":"AAA/User Properties", "description":"Use for managing user properties." }, { "name":"AAA/Users", "description":"Use for managing users." }, { "name":"Broker Control/Application Config Types", "description":"Use for managing application configuration types." }, { "name":"Broker Control/Broker Services", "description":"Use for managing broker services." }, { "name":"Broker Control/Failover Service States", "description":"Use for viewing broker component failover states." }, { "name":"Broker Control/Jobs", "description":"Use for managing jobs." }, { "name":"Broker Control/Render Types", "description":"Use for managing render types. Broker render types describe how a particular form field should be rendered and where the contents come from. Some render types are static, such as Boolean with values true/false. Others use APIs to get the values, such as the treecombo which pulls from /api/topology/menus/readForTree." }, { "name":"Broker Control/Servers", "description":"Use for managing broker servers." }, { "name":"Core/API Batches", "description":"Use for running APIs in batches." }, { "name":"Core/Certificate Warning", "description":"Use for getting the global settings for certificate warnings." }, { "name":"Core/Global Properties", "description":"Use for managing global properties." }, { "name":"Core/Icons", "description":"Use for managing icons." }, { "name":"Core/Locales", "description":"Use for reading locales and translation text." }, { "name":"Core/Themes", "description":"Use for getting themes." }, { "name":"Core/Time Zones", "description":"Use for getting time zones." }, { "name":"Core/User Sessions", "description":"Use for managing user sessions, including logging in and out, getting session details, and changing passwords." }, { "name":"Dashboard/Dashboard Groups", "description":"Use for managing dashboard groups." }, { "name":"Dashboard/Dashboard Navigation", "description":"Use for displaying navigation for dashboards and dashboard groups." }, { "name":"Dashboard/Dashboards", "description":"Use for managing dashboards." }, { "name":"Database/Database Queries", "description":"Use for managing saved database queries." }, { "name":"Database/Database Query Tools", "description":"Use for executing queries." }, { "name":"Database/Databases", "description":"Use for managing databases." }, { "name":"Device Catalog/Device Groups", "description":"Use for managing device groups." }, { "name":"Device Catalog/Device Maintenance Windows", "description":"Use for managing device maintenance windows." }, { "name":"Device Catalog/Device Management", "description":"Use for managing multiple devices." }, { "name":"Device Catalog/Device Metadata", "description":"Use for managing device metadata." }, { "name":"Device Catalog/Device Metatypes", "description":"Use for managing device metatypes." }, { "name":"Device Catalog/Device Navigation", "description":"Use for getting information about device organization and state." }, { "name":"Device Catalog/Device Remote", "description":"Use for establishing session connections to remote devices with Guacamole." }, { "name":"Device Catalog/Device Type Categories", "description":"Use for managing device type categories." }, { "name":"Device Catalog/Device Type Vendors", "description":"Use for managing device type vendors." }, { "name":"Device Catalog/Device Types", "description":"Use for managing device types." }, { "name":"Device Catalog/Device Views", "description":"Use for retrieving device details." }, { "name":"Device Catalog/Device Zones", "description":"Use for managing device zones." }, { "name":"Device Catalog/Devices", "description":"Use for managing devices." }, { "name":"Device Configuration/Device Configuration Actions", "description":"Use for managing Topology Configuration Agent (TCA) actions." }, { "name":"Device Configuration/Device Configuration Collections", "description":"Use for managing Topology Configuration Agent (TCA) collections." }, { "name":"Device Configuration/Device Configuration Policies", "description":"Use for managing Topology Configuration Agent (TCA) policies." }, { "name":"Device Configuration/Device Configuration Profiles", "description":"Use for managing Topology Configuration Agent (TCA) profiles." }, { "name":"Device Configuration/Device Configurations", "description":"Use for viewing device configuration details." }, { "name":"Device Discovery/Discovery", "description":"Use for executing remote discovery." }, { "name":"Device Discovery/Exclusion Profiles", "description":"Use for managing discovery exclusion profiles." }, { "name":"Device Discovery/Inclusion Profiles", "description":"Use for managing discovery inclusion profiles." }, { "name":"Device Discovery/SNMP Access", "description":"Use for managing discovery SNMP access Profiles." }, { "name":"Diagrams/Diagram Groups", "description":"Use for managing diagram groups." }, { "name":"Diagrams/Diagram Menus", "description":"Use for managing diagram menus." }, { "name":"Diagrams/Diagram Navigation", "description":"Use for displaying navigation for diagrams and groups." }, { "name":"Diagrams/Diagram Tools", "description":"Use for managing diagram tools." }, { "name":"Diagrams/Diagram Types", "description":"Use for managing diagram types." }, { "name":"Diagrams/Diagrams", "description":"Use for managing diagrams." }, { "name":"Diagrams/Widgets", "description":"Use for viewing diagram widgets." }, { "name":"Event/CAPE Nodes", "description":"Use for managing event CAPE nodes." }, { "name":"Event/CAPE Policies", "description":"Use for managing event CAPE policies." }, { "name":"Event/Conversions", "description":"Use for managing event display conversions" }, { "name":"Event/Custom Event Fields", "description":"Use for managing custom event fields." }, { "name":"Event/Displays", "description":"Use for managing event displays." }, { "name":"Event/Event Filter Groups", "description":"Use for managing event filter groups." }, { "name":"Event/Event Filters", "description":"Use for managing event filters." }, { "name":"Event/Event Menus", "description":"Use for managing event menus." }, { "name":"Event/Event Navigation", "description":"Use for displaying navigation for events and event severity counts." }, { "name":"Event/Event Tools", "description":"Use for managing event tools." }, { "name":"Event/Events", "description":"Use for managing events." }, { "name":"Event/Forensic Views", "description":"Use for managing forensic views." }, { "name":"Event/Journals", "description":"Use to read and add new event journal entries." }, { "name":"Event/Mechanizations", "description":"Use for managing event mechanizations." }, { "name":"Event/Meta Events", "description":"Use for managing meta events." }, { "name":"Event/Supervised Correlations", "description":"Use to correlate events to a root cause and manage symptom events." }, { "name":"Event/Watcher Policies", "description":"Use for managing event watcher policies." }, { "name":"File/File Types", "description":"Use for managing file types." }, { "name":"File/Files", "description":"Use for managing files." }, { "name":"Gateway/Gateway Elements", "description":"Use for managing elements." }, { "name":"Gateway/Gateways", "description":"Use for managing gateways." }, { "name":"Graph/Edge Types", "description":"Use for managing graph edge types." }, { "name":"Graph/Edges", "description":"Use for managing graph edges." }, { "name":"Graph/Graphs", "description":"Use to gather topology node and edge data." }, { "name":"Graph/Node Details", "description":"Use for gathering graph node and edge details like availability and status." }, { "name":"Graph/Property Types", "description":"Use for managing property types." }, { "name":"Graph/Vertex Types", "description":"Use for managing vertex types." }, { "name":"Graph/Vertices", "description":"Use for managing vertices." }, { "name":"Link/Link Groups", "description":"Use for managing link groups." }, { "name":"Link/Link Navigation", "description":"Use for displaying navigation for links." }, { "name":"Link/Links", "description":"Use for managing links." }, { "name":"Metrics/Abnormal Profiles", "description":"Use for managing the profiles used by the Abnormal Thresholds and the Metric Abnormal Threshold Engine." }, { "name":"Metrics/All Metrics Overview", "description":"Use for viewing selected metrics and the associated data." }, { "name":"Metrics/Calculations", "description":"Use for managing metric post-collection calculations." }, { "name":"Metrics/Display Instances", "description":"Use for managing display instances which can be used to show a custom name for a metric instance, or for associating a metric instance on a physical device to a virtual device." }, { "name":"Metrics/Measurements", "description":"Use for managing metric measurements." }, { "name":"Metrics/Metric Availability Data", "description":"Use for managing availability data for metrics of an instance." }, { "name":"Metrics/Metric Categories", "description":"Use for managing metric DDO categories that can be used in dashboards." }, { "name":"Metrics/Metric Collections", "description":"Use for managing metric collections." }, { "name":"Metrics/Metric Device Group Availability Data", "description":"Use for managing the device group availability panel." }, { "name":"Metrics/Metric Groups", "description":"Use for managing metric groups." }, { "name":"Metrics/Metric Instances", "description":"Use for managing metric instances." }, { "name":"Metrics/Metric Threshold Types", "description":"Use for viewing metric threshold types." }, { "name":"Metrics/Metric Thresholds", "description":"Use for managing metric thresholds." }, { "name":"Metrics/Metric Transactions", "description":"Use for managing metric synthetic transactions." }, { "name":"Metrics/Metric Types", "description":"Use for managing metric types." }, { "name":"Metrics/Metrics", "description":"Use for managing metrics." }, { "name":"Metrics/Network Traffic", "description":"Use for viewing all metrics by device." }, { "name":"Metrics/Performance Data", "description":"Use for retrieving performance data." }, { "name":"Metrics/Poller Templates", "description":"Use for managing poller templates for use in the Polling Assignments and Polling Policies interfaces." }, { "name":"Metrics/Polling Assignments", "description":"Use for managing polling assignments." }, { "name":"Metrics/Polling Policies", "description":"Use for managing metric polling policies that can be used by the Metric Poller Discovery scheduled job." }, { "name":"Metrics/Retention Policies", "description":"Use for viewing metric data retention policies." }, { "name":"Metrics/Threshold Functions", "description":"Use for viewing metric threshold functions." }, { "name":"Metrics/Threshold Groups", "description":"Use for managing metric threshold groups." }, { "name":"Metrics/TopN Data", "description":"Use for retrieving metric TopN overview data." }, { "name":"Microservice/Helm Chart Catalog", "description":"Use for listing Helm charts." }, { "name":"Microservice/Helm Deployment", "description":"Use for managing Helm charts, including deploying, undeploying, and getting current deployment details." }, { "name":"Microservice/Kubernetes Workload", "description":"Use for reading the microservice pod." }, { "name":"Microservice/Microservice Clusters", "description":"Use for managing microservice clusters." }, { "name":"Navigation/Bookmarks", "description":"Use for managing user bookmarks." }, { "name":"Navigation/Navigation Configurations", "description":"Use for viewing keywords." }, { "name":"Notification/Notification Profiles", "description":"Use for managing notification profiles." }, { "name":"Notification/Notification Templates", "description":"Use for managing notification templates." }, { "name":"Package/Package Depots", "description":"Use for managing global properties." }, { "name":"Report/Report Profiles", "description":"Use for managing report profiles." }, { "name":"Report/Reports", "description":"Use for managing reports." }, { "name":"Rule/Rule Branches", "description":"Use for managing rule branches." }, { "name":"Rule/Rules", "description":"Use for managing rules files." }, { "name":"SLM/SLM Navigation", "description":"Use for displaying navigation for SLM services." }, { "name":"SLM/SLM Services", "description":"Use for managing SLM services." }, { "name":"SLM/Service Filters", "description":"Use for managing SLM filters." }, { "name":"SLM/Service Metrics", "description":"Use for managing SLM metrics." }, { "name":"SLM/Service Views", "description":"Use for retrieving SLM services." }, { "name":"Topology/Topology Menus", "description":"Use for managing topology menus." }, { "name":"Topology/Topology Network Details", "description":"Use for retrieving topology network details." }, { "name":"Topology/Topology Tools", "description":"Use for managing topology tools." } ], "paths":{ "/api/AAA/AuthTypes/{id}":{ "get":{ "tags":[ "AAA/Authentication Types" ], "summary":"Get an Authentication Type Instance by ID", "description":"Gets the authentication type instance that matches the specified ID or name.", "operationId":"AAA::AuthTypes::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The authentication type instance ID or name. Can be an integer (for ID) or string (for name).", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":3 } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAAuthTypesRead" } } } } ] }, "example":{ "success":"true", "message":"Loaded 1 entries", "total":"1", "data":[ { "ADHost1":"ad1.example.com", "ADHost2":"ad2.example.com", "ADSecureConnection":"1", "AuthenticationDomain":"ad.example.com", "AuthenticationTypeID":"3", "AuthenticationTypeName":"Active Directory 1", "AuthenticationTypeProtocol":"Active Directory", "AuthenticationStatusIcon":"OrbGreen.png", "AuthenticationStatus":"1", "DefaultInstance":"1" } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-AuthTypes-{id}-get", "x-filename-id":"api-aaa-authtypes-id-get" }, "put":{ "tags":[ "AAA/Authentication Types" ], "summary":"Update an Authentication Type Instance", "description":"Updates the properties of the authentication type instance that matches the specified ID.", "operationId":"AAA::AuthTypes::update", "parameters":[ { "name":"id", "in":"path", "description":"The authentication type instance ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":4 } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AAAAuthTypesUpdate" }, "example":{ "AuthenticationDomain":"ldap.example.com", "AuthenticationTypeName":"LDAP 1", "AuthenticationTypeProtocol":"LDAP", "AuthenticationStatus":"1", "DefaultInstance":"0", "LDAPDN":"CN=%s,OU=Users,DC=example,DC=com", "LDAPHost1":"ldap.example.com", "LDAPHost2":"ldap2.example.com", "LDAPPort":"636", "LDAPSecureConnection":"1" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAAuthTypesRead" } } } } ] }, "example":{ "success":"true", "message":"Updated record", "total":"1", "data":[ { "AuthenticationDomain":"ldap.example.com", "AuthenticationTypeName":"LDAP 1", "AuthenticationTypeProtocol":"LDAP", "AuthenticationStatus":"1", "DefaultInstance":"0", "LDAPDN":"CN=%s,OU=Users,DC=example,DC=com", "LDAPHost1":"ldap.example.com", "LDAPHost2":"ldap2.example.com", "LDAPPort":"636", "LDAPSecureConnection":"1" } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-AuthTypes-{id}-put", "x-filename-id":"api-aaa-authtypes-id-put" }, "delete":{ "tags":[ "AAA/Authentication Types" ], "summary":"Delete an Authentication Type Instance", "description":"Deletes the authentication type instance that matches the specified ID. You cannot delete authentication type instances that have associated users. First you must remove the users or update them to use a different authentication type instance. You can never delete the default internal authentication type (ID: 1).", "operationId":"AAA::AuthTypes::delete", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the authentication type instance to delete.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":5 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-AuthTypes-{id}-delete", "x-filename-id":"api-aaa-authtypes-id-delete" } }, "/api/AAA/AuthTypes":{ "get":{ "tags":[ "AAA/Authentication Types" ], "summary":"Get Authentication Type Instances", "description":"Gets the authentication type instances that match the specified parameters. If no parameters are specified, all authentication type instances are returned.", "operationId":"AAA::AuthTypes::read", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAAuthTypesRead" } } } } ] }, "example":{ "success":"true", "message":"Loaded 1 entries", "total":"1", "data":[ { "ADHost1":"ad1.example.com", "ADHost2":"ad2.example.com", "ADSecureConnection":"1", "AuthenticationDomain":"ad.example.com", "AuthenticationTypeID":"3", "AuthenticationTypeName":"Active Directory 1", "AuthenticationTypeProtocol":"Active Directory", "AuthenticationStatusIcon":"OrbGreen.png", "AuthenticationStatus":"1", "DefaultInstance":"1" } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-AuthTypes-get", "x-filename-id":"api-aaa-authtypes-get" }, "post":{ "tags":[ "AAA/Authentication Types" ], "summary":"Create an Authentication Type Instance", "description":"Creates a new authentication type instance. You can create multiple instances of the SAML, LDAP, and Active Directory authentication types. There will always be only one Internal authentication type instance.
The minimum required properties in the request body are:\n ", "operationId":"AAA::AuthTypes::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AAAAuthTypesCreate", "required":[ "AuthenticationTypeName", "AuthenticationTypeProtocol", "AuthenticationStatus" ] }, "example":{ "AuthenticationDomain":"saml.example.com", "AuthenticationTypeName":"SAML SSO 1", "AuthenticationTypeProtocol":"SAML", "AuthenticationStatus":"1", "Certificate":"", "EntityID":"example.com/saml-idp", "NameIDFormat":"urn:oasis:names:tc:SAML:2.0:nameid-format:persistent", "SingleLogoutService":"example.com/saml/saml2/idp/SingleLogoutService.php", "SingleSignOnService":"example.com/saml/saml2/idp/SSOService.php" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAAuthTypesRead" } } } } ] }, "example":{ "success":"true", "message":"Added record", "total":"1", "data":[ { "AuthenticationDomain":"saml.example.com", "AuthenticationTypeID":"5", "AuthenticationTypeName":"SAML SSO 1", "AuthenticationTypeProtocol":"SAML", "AuthenticationStatusIcon":"OrbGreen.png", "AuthenticationStatus":"1", "Certificate":"", "EntityID":"example.com/saml-idp", "NameIDFormat":"urn:oasis:names:tc:SAML:2.0:nameid-format:persistent" } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-AuthTypes-post", "x-filename-id":"api-aaa-authtypes-post" } }, "/api/AAA/AuthTypes/readForSelect":{ "get":{ "tags":[ "AAA/Authentication Types" ], "summary":"Get Authentication Type Instances for Combo Boxes and Item Selectors", "description":"Gets authentication type instances in a format suitable for combo boxes and item selectors. This method only returns enabled authentication type instances.", "operationId":"AAA::AuthTypes::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAAuthTypesReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-AuthTypes-readForSelect-get", "x-filename-id":"api-aaa-authtypes-readforselect-get" } }, "/api/AAA/Permissions/{id}":{ "get":{ "tags":[ "AAA/Permissions" ], "summary":"Get a Permission by ID", "description":"Gets the permission that matches the specified ID.", "operationId":"AAA::Permissions::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The permission ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1001" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAPermissionsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-Permissions-{id}-get", "x-filename-id":"api-aaa-permissions-id-get" } }, "/api/AAA/Permissions":{ "get":{ "tags":[ "AAA/Permissions" ], "summary":"Get Permissions", "description":"Gets the permissions that match the specified parameters. If no parameters are specified, all permissions are returned.", "operationId":"AAA::Permissions::read", "parameters":[ { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAPermissionsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-Permissions-get", "x-filename-id":"api-aaa-permissions-get" } }, "/api/AAA/Permissions/readForSelect":{ "get":{ "tags":[ "AAA/Permissions" ], "summary":"Get Permissions for Combo Boxes and Item Selectors", "description":"Gets permissions in a format suitable for combo boxes and item selectors.", "operationId":"AAA::Permissions::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAPermissionsReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-Permissions-readForSelect-get", "x-filename-id":"api-aaa-permissions-readforselect-get" } }, "/api/AAA/Preferences/{id}":{ "get":{ "tags":[ "AAA/Preferences" ], "summary":"Get a Preference by ID", "description":"Gets the preference that matches the specified ID.", "operationId":"AAA::Preferences::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The preference ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"3" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAPreferenceRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-Preferences-{id}-get", "x-filename-id":"api-aaa-preferences-id-get" }, "put":{ "tags":[ "AAA/Preferences" ], "summary":"Update a Preference", "description":"Updates the properties of the preference that matches the specified ID.", "operationId":"AAA::Preferences::update", "parameters":[ { "name":"id", "in":"path", "description":"The preference ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AAAPreferences" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAPreferenceRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-Preferences-{id}-put", "x-filename-id":"api-aaa-preferences-id-put" }, "delete":{ "tags":[ "AAA/Preferences" ], "summary":"Delete a Preference", "description":"Deletes a preference that matches the specified ID.", "operationId":"AAA::Preferences::delete", "parameters":[ { "name":"id", "in":"path", "description":"The preference ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-Preferences-{id}-delete", "x-filename-id":"api-aaa-preferences-id-delete" } }, "/api/AAA/Preferences":{ "get":{ "tags":[ "AAA/Preferences" ], "summary":"Get Preferences", "description":"Gets the preferences that match the specified parameters. If no parameters are specified, all preferences are returned.", "operationId":"AAA::Preferences::read", "parameters":[ { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAPreferenceRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-Preferences-get", "x-filename-id":"api-aaa-preferences-get" }, "post":{ "tags":[ "AAA/Preferences" ], "summary":"Create a Preference", "description":"Creates a new preference.
The minimum required properties in the request body are:\n ", "operationId":"AAA::Preferences::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AAAPreferences", "required":[ "PreferenceName", "PackageName" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAPreferenceRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-Preferences-post", "x-filename-id":"api-aaa-preferences-post" } }, "/api/AAA/Preferences/readForSelect":{ "get":{ "tags":[ "AAA/Preferences" ], "summary":"Get Preferences for Combo Boxes and Item Selectors", "description":"Gets preferences in a format suitable for combo boxes and item selectors.", "operationId":"AAA::Preferences::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/query" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAPreferencesReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-Preferences-readForSelect-get", "x-filename-id":"api-aaa-preferences-readforselect-get" } }, "/api/AAA/Roles/{id}":{ "get":{ "tags":[ "AAA/Roles" ], "summary":"Get a Role by ID", "description":"Gets the role that matches the specified ID.", "operationId":"AAA::Roles::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The role ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAARolesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-Roles-{id}-get", "x-filename-id":"api-aaa-roles-id-get" }, "put":{ "tags":[ "AAA/Roles" ], "summary":"Update a Role", "description":"Updates the properties of the role that matches the specified ID.", "operationId":"AAA::Roles::update", "parameters":[ { "name":"id", "in":"path", "description":"The role ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AAARoles" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAARolesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-Roles-{id}-put", "x-filename-id":"api-aaa-roles-id-put" }, "delete":{ "tags":[ "AAA/Roles" ], "summary":"Delete a Role", "description":"Deletes the role that matches the specified ID.", "operationId":"AAA::Roles::delete", "parameters":[ { "name":"id", "in":"path", "description":"The role ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-Roles-{id}-delete", "x-filename-id":"api-aaa-roles-id-delete" } }, "/api/AAA/Roles":{ "get":{ "tags":[ "AAA/Roles" ], "summary":"Get Roles", "description":"Gets the roles that match the specified parameters. If no parameters are specified, all roles are returned.", "operationId":"AAA::Roles::read", "parameters":[ { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAARolesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-Roles-get", "x-filename-id":"api-aaa-roles-get" }, "post":{ "tags":[ "AAA/Roles" ], "summary":"Create a Role", "description":"Creates a new role.
The minimum required properties in the request body are:\n ", "operationId":"AAA::Roles::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AAARoles", "required":[ "RoleName", "Permissions" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAARolesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-Roles-post", "x-filename-id":"api-aaa-roles-post" } }, "/api/AAA/Roles/readForSelect":{ "get":{ "tags":[ "AAA/Roles" ], "summary":"Get Roles for Combo Boxes and Item Selectors", "description":"Gets roles in a format suitable for combo boxes and item selectors.", "operationId":"AAA::Roles::readForSelect", "parameters":[ { "name":"id", "in":"query", "description":"The role ID.", "schema":{ "type":"integer", "format":"int32" }, "example":1 }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAARolesReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-Roles-readForSelect-get", "x-filename-id":"api-aaa-roles-readforselect-get" } }, "/api/AAA/Tenants/{id}":{ "get":{ "tags":[ "AAA/Tenants" ], "summary":"Get a Tenant by ID", "description":"Gets the tenant that matches the specified ID.", "operationId":"AAA::Tenants::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The tenant ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAATenantsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-Tenants-{id}-get", "x-filename-id":"api-aaa-tenants-id-get" }, "put":{ "tags":[ "AAA/Tenants" ], "summary":"Update a Tenant", "description":"Updates the properties of the tenant that matches the specified ID.", "operationId":"AAA::Tenants::update", "parameters":[ { "name":"id", "in":"path", "description":"The tenant ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AAATenants" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAATenantsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-Tenants-{id}-put", "x-filename-id":"api-aaa-tenants-id-put" }, "delete":{ "tags":[ "AAA/Tenants" ], "summary":"Delete a Tenant", "description":"Deletes the tenant that matches the specified ID.", "operationId":"AAA::Tenants::delete", "parameters":[ { "name":"id", "in":"path", "description":"The tenant ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-Tenants-{id}-delete", "x-filename-id":"api-aaa-tenants-id-delete" } }, "/api/AAA/Tenants":{ "get":{ "tags":[ "AAA/Tenants" ], "summary":"Get Tenants", "description":"Gets the tenants that match the specified parameters. If no parameters are specified, all tenants are returned.", "operationId":"AAA::Tenants::read", "parameters":[ { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAATenantsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-Tenants-get", "x-filename-id":"api-aaa-tenants-get" }, "post":{ "tags":[ "AAA/Tenants" ], "summary":"Create a Tenant", "description":"Creates a new tenant.
The minimum required properties in the request body are:\n ", "operationId":"AAA::Tenants::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AAATenants", "required":[ "TenantName", "UserGroups", "DeviceZones" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAATenantsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-Tenants-post", "x-filename-id":"api-aaa-tenants-post" } }, "/api/AAA/UserGroupProperties/{id}":{ "get":{ "tags":[ "AAA/User Group Properties" ], "summary":"Get a User Group Property by ID", "description":"Gets the user group property that matches the specified ID.", "operationId":"AAA::UserGroupProperties::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The property ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"3" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAUserGroupPropertiesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-UserGroupProperties-{id}-get", "x-filename-id":"api-aaa-usergroupproperties-id-get" }, "put":{ "tags":[ "AAA/User Group Properties" ], "summary":"Update a User Group Property", "description":"Updates the properties of the user group property that matches the specified ID.", "operationId":"AAA::UserGroupProperties::update", "parameters":[ { "name":"id", "in":"path", "description":"The property ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AAAUserGroupProperties" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAUserGroupPropertiesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-UserGroupProperties-{id}-put", "x-filename-id":"api-aaa-usergroupproperties-id-put" }, "delete":{ "tags":[ "AAA/User Group Properties" ], "summary":"Delete a User Group Property", "description":"Deletes the user group property that matches the specified ID.", "operationId":"AAA::UserGroupProperties::delete", "parameters":[ { "name":"id", "in":"path", "description":"The property ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-UserGroupProperties-{id}-delete", "x-filename-id":"api-aaa-usergroupproperties-id-delete" } }, "/api/AAA/UserGroupProperties":{ "get":{ "tags":[ "AAA/User Group Properties" ], "summary":"Get User Group Properties", "description":"Gets the user group properties that match the specified parameters. If no parameters are specified, all user group properties are returned.", "operationId":"AAA::UserGroupProperties::read", "parameters":[ { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAUserGroupPropertiesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-UserGroupProperties-get", "x-filename-id":"api-aaa-usergroupproperties-get" }, "post":{ "tags":[ "AAA/User Group Properties" ], "summary":"Create a User Group Property", "description":"Creates a new user group property. At minimum, the PropertyName property is required in the request body.", "operationId":"AAA::UserGroupProperties::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AAAUserGroupProperties", "required":[ "PropertyName" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAUserGroupPropertiesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-UserGroupProperties-post", "x-filename-id":"api-aaa-usergroupproperties-post" } }, "/api/AAA/UserGroupProperties/readForSelect":{ "get":{ "tags":[ "AAA/User Group Properties" ], "summary":"Get User Group Properties for Combo Boxes and Item Selectors", "description":"Gets user group properties in a format suitable for combo boxes and item selectors.", "operationId":"AAA::UserGroupProperties::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAUserGroupPropertiesReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-UserGroupProperties-readForSelect-get", "x-filename-id":"api-aaa-usergroupproperties-readforselect-get" } }, "/api/AAA/UserGroups/{id}":{ "get":{ "tags":[ "AAA/User Groups" ], "summary":"Get a User Group by ID", "description":"Gets the user group that matches the specified ID.", "operationId":"AAA::UserGroups::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The user group ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAUserGroupsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-UserGroups-{id}-get", "x-filename-id":"api-aaa-usergroups-id-get" }, "put":{ "tags":[ "AAA/User Groups" ], "summary":"Update a User Group", "description":"Updates the properties of the user group that matches the specified ID.", "operationId":"AAA::UserGroups::update", "parameters":[ { "name":"id", "in":"path", "description":"The user group ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AAAUserGroups" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAUserGroupsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-UserGroups-{id}-put", "x-filename-id":"api-aaa-usergroups-id-put" }, "delete":{ "tags":[ "AAA/User Groups" ], "summary":"Delete a User Group", "description":"Deletes the user group that matches the specified ID. A group can only be deleted after any users in the group are removed.", "operationId":"AAA::UserGroups::delete", "parameters":[ { "name":"id", "in":"path", "description":"The user group ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-UserGroups-{id}-delete", "x-filename-id":"api-aaa-usergroups-id-delete" } }, "/api/AAA/UserGroups":{ "get":{ "tags":[ "AAA/User Groups" ], "summary":"Get User Groups", "description":"Gets the user groups that match the specified parameters. If no parameters are specified, all user groups are returned.", "operationId":"AAA::UserGroups::read", "parameters":[ { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAUserGroupsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-UserGroups-get", "x-filename-id":"api-aaa-usergroups-get" }, "post":{ "tags":[ "AAA/User Groups" ], "summary":"Create a User Group", "description":"Creates a new user group.
The minimum required properties in the request body are:\n ", "operationId":"AAA::UserGroups::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AAAUserGroups", "required":[ "UserGroupName", "RoleID", "Users", "Properties", "Preferences" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAUserGroupsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-UserGroups-post", "x-filename-id":"api-aaa-usergroups-post" } }, "/api/AAA/UserGroups/readForSelect":{ "get":{ "tags":[ "AAA/User Groups" ], "summary":"Get User Groups for Combo Boxes and Item Selectors", "description":"Gets user groups in a format suitable for combo boxes and item selectors. If the user making the request is not a publisher or admin user, the API will only return the group that the requesting user belongs to.", "operationId":"AAA::UserGroups::readForSelect", "parameters":[ { "name":"id", "in":"query", "required":false, "description":"The ID of a specific user group to get. If you specify this, but you are not a publisher or an admin user, the UserGroupName in the response will be [HIDDEN].", "schema":{ "type":"integer" } }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAUserGroupsReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-UserGroups-readForSelect-get", "x-filename-id":"api-aaa-usergroups-readforselect-get" } }, "/api/AAA/UserProfiles/{id}":{ "get":{ "tags":[ "AAA/User Profiles" ], "summary":"Get a User Profile by ID", "description":"Gets the user profile that matches the specified ID.", "operationId":"AAA::UserProfiles::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The user profile ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"3" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAUsersRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-UserProfiles-{id}-get", "x-filename-id":"api-aaa-userprofiles-id-get" }, "put":{ "tags":[ "AAA/User Profiles" ], "summary":"Update a User Profile", "description":"Updates the configuration of the user profile that matches the specified ID.", "operationId":"AAA::UserProfiles::update", "parameters":[ { "name":"id", "in":"path", "description":"The user profile ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AAAUserProfiles" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAUsersRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-UserProfiles-{id}-put", "x-filename-id":"api-aaa-userprofiles-id-put" } }, "/api/AAA/UserProperties/{id}":{ "get":{ "tags":[ "AAA/User Properties" ], "summary":"Get a User Property by ID", "description":"Gets the user property that matches the specified ID.", "operationId":"AAA::UserProperties::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The user property ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"3" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAUserPropertiesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-UserProperties-{id}-get", "x-filename-id":"api-aaa-userproperties-id-get" }, "put":{ "tags":[ "AAA/User Properties" ], "summary":"Update a User Property", "description":"Updates the user property that matches the specified ID.", "operationId":"AAA::UserProperties::update", "parameters":[ { "name":"id", "in":"path", "description":"The user property ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AAAUserProperties" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAUserPropertiesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-UserProperties-{id}-put", "x-filename-id":"api-aaa-userproperties-id-put" }, "delete":{ "tags":[ "AAA/User Properties" ], "summary":"Delete a User Property", "description":"Deletes the user property that matches the specified ID.", "operationId":"AAA::UserProperties::delete", "parameters":[ { "name":"id", "in":"path", "description":"The user property ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-UserProperties-{id}-delete", "x-filename-id":"api-aaa-userproperties-id-delete" } }, "/api/AAA/UserProperties":{ "get":{ "tags":[ "AAA/User Properties" ], "summary":"Get User Properties", "description":"Gets the user properties that match the specified parameters. If no parameters are specified, all user properties are returned.", "operationId":"AAA::UserProperties::read", "parameters":[ { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAUserPropertiesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-UserProperties-get", "x-filename-id":"api-aaa-userproperties-get" }, "post":{ "tags":[ "AAA/User Properties" ], "summary":"Create a User Property", "description":"Creates a new user property. At minimum, the PropertyName property is required in the request body.", "operationId":"AAA::UserProperties::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AAAUserProperties", "required":[ "PropertyName" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAUserPropertiesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-UserProperties-post", "x-filename-id":"api-aaa-userproperties-post" } }, "/api/AAA/UserProperties/readForSelect":{ "get":{ "tags":[ "AAA/User Properties" ], "summary":"Get User Properties for Combo Boxes and Item Selectors", "description":"Gets user properties in a format suitable for combo boxes and item selectors.", "operationId":"AAA::UserProperties::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAUserPropertiesReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-UserProperties-readForSelect-get", "x-filename-id":"api-aaa-userproperties-readforselect-get" } }, "/api/AAA/Users/{id}":{ "get":{ "tags":[ "AAA/Users" ], "summary":"Get a User by ID", "description":"Gets the user that matches the specified ID.", "operationId":"AAA::Users::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The user ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAUsersRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-Users-{id}-get", "x-filename-id":"api-aaa-users-id-get" }, "put":{ "tags":[ "AAA/Users" ], "summary":"Update a User", "description":"Updates the properties of the user that matches the specified ID.", "operationId":"AAA::Users::update", "parameters":[ { "name":"id", "in":"path", "description":"The user ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AAAUsers" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAUsersRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-Users-{id}-put", "x-filename-id":"api-aaa-users-id-put" }, "delete":{ "tags":[ "AAA/Users" ], "summary":"Delete a User", "description":"Deletes the user that matches the specified ID.", "operationId":"AAA::Users::delete", "parameters":[ { "name":"id", "in":"path", "description":"The user ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-Users-{id}-delete", "x-filename-id":"api-aaa-users-id-delete" } }, "/api/AAA/Users":{ "get":{ "tags":[ "AAA/Users" ], "summary":"Get Users", "description":"Gets the users that match the specified parameters. If no parameters are specified, all users are returned.", "operationId":"AAA:Users:read", "parameters":[ { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAUsersRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-Users-get", "x-filename-id":"api-aaa-users-get" }, "post":{ "tags":[ "AAA/Users" ], "summary":"Create a User", "description":"Creates a new user.
The minimum required properties in the request body are:\n ", "operationId":"AAA::Users::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/AAAUsers", "required":[ "UserName", "FullName", "PasswordChange", "PasswordExpiration", "AccountExpiration", "UserGroup", "Subgroups", "AuthenticationType", "AccountStatus", "Properties", "Preferences" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAUsersRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-Users-post", "x-filename-id":"api-aaa-users-post" } }, "/api/AAA/Users/readForSelect":{ "get":{ "tags":[ "AAA/Users" ], "summary":"Get Users for Combo Boxes and Item Selectors", "description":"Gets users in a format suitable for combo boxes and item selectors. If the user making the request is not a publisher or admin user, the API will only return the users from the same user group as the requesting user.", "operationId":"AAA::Users::readForSelect", "parameters":[ { "name":"id", "in":"query", "required":false, "description":"The ID of a specific user to get. If you specify this, but you are not a publisher or an admin user, the UserName in the response will be [HIDDEN].", "schema":{ "type":"integer" } }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/AAAUsersReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-AAA-Users-readForSelect-get", "x-filename-id":"api-aaa-users-readforselect-get" } }, "/api/broker/Jobs/{id}":{ "get":{ "tags":[ "Broker Control/Jobs" ], "summary":"Get a Job by ID", "description":"Gets the job that matches the specified ID.", "operationId":"broker::Jobs::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The job ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/brokerJobsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-Jobs-{id}-get", "x-filename-id":"api-broker-jobs-id-get" }, "delete":{ "tags":[ "Broker Control/Jobs" ], "summary":"Delete a Job", "description":"Deletes the job that matches the specified ID.", "operationId":"broker::Jobs::delete", "parameters":[ { "name":"id", "in":"path", "description":"The job ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-Jobs-{id}-delete", "x-filename-id":"api-broker-jobs-id-delete" }, "put":{ "tags":[ "Broker Control/Jobs" ], "summary":"Update a Job", "description":"Updates the properties of a job that matches the specified ID.", "operationId":"broker::Jobs::update", "parameters":[ { "name":"id", "in":"path", "description":"The job ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/brokerJobsCreate" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/brokerJobsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-Jobs-{id}-put", "x-filename-id":"api-broker-jobs-id-put" } }, "/api/broker/Jobs":{ "get":{ "tags":[ "Broker Control/Jobs" ], "summary":"Get Jobs", "description":"Gets the jobs that match the specified parameters. If no parameters are specified, all jobs are returned.", "operationId":"broker::Jobs::read", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/brokerJobsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-Jobs-get", "x-filename-id":"api-broker-jobs-get" }, "post":{ "tags":[ "Broker Control/Jobs" ], "summary":"Create a Job", "description":"Creates a new job.
The minimum required properties in the request body are:\n ", "operationId":"broker::Jobs::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/brokerJobsCreate", "required":[ "ServerID", "PackageName", "JobName", "JobProgram", "IsScheduled", "Minutes", "Hours", "Days", "Months", "WeekDays", "StatusID", "FailoverType", "Privileged", "ApplicationConfig" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/brokerJobsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-Jobs-post", "x-filename-id":"api-broker-jobs-post" } }, "/api/broker/Jobs/readForSelect":{ "get":{ "tags":[ "Broker Control/Jobs" ], "summary":"Get Jobs for Combo Boxes and Item Selectors", "description":"Gets jobs in a format suitable for combo boxes and item selectors.", "operationId":"broker::Jobs::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/brokerJobsReadForSelect" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-Jobs-readForSelect-get", "x-filename-id":"api-broker-jobs-readforselect-get" } }, "/api/broker/Jobs/readStates":{ "get":{ "tags":[ "Broker Control/Jobs" ], "summary":"Get Job States", "description":"Gets the states of the broker jobs that match the specified parameters. If no parameters are specified, the states of all jobs are returned.", "operationId":"broker::Jobs::readStates", "parameters":[ { "name":"Servers", "in":"query", "description":"The array of server IDs.", "schema":{ "type":"array", "items":{ "type":"integer" } }, "example":[ "3", "5" ] } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/brokerJobsReadStates" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-Jobs-readStates-get", "x-filename-id":"api-broker-jobs-readstates-get" } }, "/api/broker/Jobs/executeStart":{ "get":{ "tags":[ "Broker Control/Jobs" ], "summary":"Start a Job", "description":"Starts the job that matches the specified JobID and JobName.", "operationId":"broker::Jobs::executeStart", "parameters":[ { "name":"id", "in":"query", "description":"The job ID.", "schema":{ "type":"integer" }, "example":24 }, { "name":"name", "in":"query", "description":"The job name.", "schema":{ "type":"string" }, "example":"Test Job" }, { "name":"JobArguments", "in":"query", "description":"Additional job options.
For example, you can use -d $DeviceID with Device SNMP Discovery, Gather Network Inventory, or Gather Configurations jobs to discover and gather information about a specific device.
See the documentation for each application in Unified Assurance Implementation Guide for details about the options available for each application run as a job.", "required":false, "schema":{ "type":"string" }, "example":"-d $DeviceID" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"object", "additionalProperties":{ "type":"string", "description":"Uses the format \"ServerName/JobName\" as the property or key and status of the job or process as the value." }, "example":{ "server.com/testJobName":"Process queued to start" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-Jobs-executeStart-get", "x-filename-id":"api-broker-jobs-executestart-get" } }, "/api/broker/FailoverStates":{ "get":{ "tags":[ "Broker Control/Failover Service States" ], "summary":"Get Details of All Failover Service States", "description":"Gets the details of all the services across the Unified Assurance installation that are configured in either a Primary/Backup failover state or in a Cluster state. You can narrow down the results further by using the query parameters.", "operationId":"broker::FailoverStates::read", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/brokerFailoverStatesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-FailoverStates-get", "x-filename-id":"api-broker-failoverstates-get" } }, "/api/broker/renderTypes":{ "get":{ "tags":[ "Broker Control/Render Types" ], "summary":"Get Render Types", "description":"Gets the render types that match the specified parameters. If no parameters are specified, all render types are returned.", "operationId":"broker::RenderTypes::read", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/brokerRenderTypesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-renderTypes-get", "x-filename-id":"api-broker-rendertypes-get" } }, "/api/broker/renderTypes/{id}":{ "get":{ "tags":[ "Broker Control/Render Types" ], "summary":"Get a Render Type by ID", "description":"Gets the render type that matches the specified ID.", "operationId":"broker::RenderTypes::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The render type ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/brokerRenderTypesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-renderTypes-{id}-get", "x-filename-id":"api-broker-rendertypes-id-get" } }, "/api/broker/RenderTypes/readForSelect":{ "get":{ "tags":[ "Broker Control/Render Types" ], "summary":"Get Render Types for Combo Boxes and Item Selectors", "description":"Gets render types in a format suitable for combo boxes and item selectors.", "operationId":"broker::RenderTypes::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/brokerRenderTypesReadForSelect" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-RenderTypes-readForSelect-get", "x-filename-id":"api-broker-rendertypes-readforselect-get" } }, "/api/broker/ApplicationConfigTypes":{ "get":{ "tags":[ "Broker Control/Application Config Types" ], "summary":"Get Application Configuration Types", "description":"Gets the application configuration types that match the specified parameters. If no parameters are specified, all application configuration types are returned.", "operationId":"broker::ApplicationConfigTypes::read", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/brokerApplicationConfigTypesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-ApplicationConfigTypes-get", "x-filename-id":"api-broker-applicationconfigtypes-get" }, "post":{ "tags":[ "Broker Control/Application Config Types" ], "summary":"Create an Application Configuration Type", "description":"Creates a new application configuration type.
The minimum required properties in the request body are:\n ", "operationId":"broker::ApplicationConfigTypes::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/brokerApplicationConfigTypesCreate", "required":[ "BrokerApplicationConfigName", "RenderTypeID" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/brokerApplicationConfigTypesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-ApplicationConfigTypes-post", "x-filename-id":"api-broker-applicationconfigtypes-post" } }, "/api/broker/ApplicationConfigTypes/{id}":{ "get":{ "tags":[ "Broker Control/Application Config Types" ], "summary":"Get an Application Configuration Type by ID", "description":"Gets the application configuration type that matches the specified ID.", "operationId":"broker::ApplicationConfigTypes::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The application configuration type ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/brokerApplicationConfigTypesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-ApplicationConfigTypes-{id}-get", "x-filename-id":"api-broker-applicationconfigtypes-id-get" }, "delete":{ "tags":[ "Broker Control/Application Config Types" ], "summary":"Delete an Application Configuration Type", "description":"Deletes the application configuration type that matches the specified ID.", "operationId":"broker::ApplicationConfigTypes::delete", "parameters":[ { "name":"id", "in":"path", "description":"The application configuration type ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-ApplicationConfigTypes-{id}-delete", "x-filename-id":"api-broker-applicationconfigtypes-id-delete" }, "put":{ "tags":[ "Broker Control/Application Config Types" ], "summary":"Update an Application Configuration Type", "description":"Updates the properties of the application configuration type that matches the specified ID.", "operationId":"broker::ApplicationConfigTypes::update", "parameters":[ { "name":"id", "in":"path", "description":"The application configuration type ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/brokerApplicationConfigTypesCreate" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/brokerApplicationConfigTypesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-ApplicationConfigTypes-{id}-put", "x-filename-id":"api-broker-applicationconfigtypes-id-put" } }, "/api/broker/Servers":{ "get":{ "tags":[ "Broker Control/Servers" ], "summary":"Get Broker Servers", "description":"Gets the broker servers that match the specified parameters. If no parameters are specified, all broker servers are returned.", "operationId":"broker::Servers::read", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/brokerServersRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-Servers-get", "x-filename-id":"api-broker-servers-get" } }, "/api/broker/Servers/{id}":{ "get":{ "tags":[ "Broker Control/Servers" ], "summary":"Get a Broker Server by ID", "description":"Gets the broker server that matches the specified ID.", "operationId":"broker::Servers::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The broker server ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/brokerServersRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-Servers-{id}-get", "x-filename-id":"api-broker-servers-id-get" }, "delete":{ "tags":[ "Broker Control/Servers" ], "summary":"Delete a Broker Server", "description":"Deletes the broker server that matches the specified ID.", "operationId":"broker::Servers::delete", "parameters":[ { "name":"id", "in":"path", "description":"The broker server ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-Servers-{id}-delete", "x-filename-id":"api-broker-servers-id-delete" }, "put":{ "tags":[ "Broker Control/Servers" ], "summary":"Update a Broker Server", "description":"Updates the broker server that matches the specified ID.", "operationId":"broker::Server::update", "parameters":[ { "name":"id", "in":"path", "description":"The broker server ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/brokerServersUpdate" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/brokerServersRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-Servers-{id}-put", "x-filename-id":"api-broker-servers-id-put" } }, "/api/broker/Servers/readForSelect":{ "get":{ "tags":[ "Broker Control/Servers" ], "summary":"Get Broker Servers for Combo Boxes and Item Selectors", "description":"Gets broker servers in a format suitable for combo boxes and item selectors.", "operationId":"broker::Servers::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "type":"object", "properties":{ "ServerID":{ "description":"The server ID.", "type":"integer", "example":"9" }, "ServerName":{ "description":"The server name.", "type":"string", "example":"example.com" } } } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-Servers-readForSelect-get", "x-filename-id":"api-broker-servers-readforselect-get" } }, "/api/broker/Servers/readStates":{ "get":{ "tags":[ "Broker Control/Servers" ], "summary":"Get States of Broker Servers", "description":"Gets the states of broker servers that match the specified parameters. If no parameters are specified, all broker server states are returned.", "operationId":"broker::Servers::readStates", "parameters":[ { "name":"ServerID", "in":"query", "description":"The list of server IDs.", "schema":{ "type":"string" }, "example":"3,5,6" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/brokerServersReadStates" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-Servers-readStates-get", "x-filename-id":"api-broker-servers-readstates-get" } }, "/api/broker/Servers/readEULAAcceptance":{ "get":{ "tags":[ "Broker Control/Servers" ], "summary":"Get Acceptance of EULA", "description":"Checks if the end-user license agreements (EULAs) have been accepted for this Unified Assurance account. The EULAs are for Unified Assurance and third parties like Neo4j and Sourceguardian Loader.", "operationId":"broker::Servers::readEULAAcceptance", "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "message":{ "type":"string", "example":"EULAs accepted" }, "data":{ "type":"array", "items":{ } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-Servers-readEULAAcceptance-get", "x-filename-id":"api-broker-servers-readeulaacceptance-get" } }, "/api/broker/Servers/readInstallStatus":{ "get":{ "tags":[ "Broker Control/Servers" ], "summary":"Get Install Status of Server Roles", "description":"Gets the install status of server roles and subroles for servers matching the specified parameters. If no parameters are specified, all servers are returned.", "operationId":"broker::Servers::readInstallStatus", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/brokerServersReadInstallStatus" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-Servers-readInstallStatus-get", "x-filename-id":"api-broker-servers-readinstallstatus-get" } }, "/api/broker/Servers/readVersions":{ "get":{ "tags":[ "Broker Control/Servers" ], "summary":"Get Available Versions of Unified Assurance Package", "description":"Gets the available versions of the Unified Assurance package depots.", "operationId":"broker::Servers::readVersions", "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "type":"object", "properties":{ "version":{ "description":"The version number.", "type":"string", "example":"6.0.3.2" }, "depotName":{ "description":"An array having a single element representing the name of the depot for the version.", "type":"array", "items":{ }, "example":"example.com" } } } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-Servers-readVersions-get", "x-filename-id":"api-broker-servers-readversions-get" } }, "/api/broker/Servers/updateServers":{ "post":{ "tags":[ "Broker Control/Servers" ], "summary":"Update Server Version", "description":"Updates the installed version of Unified Assurance on a selected server. You can only update to a higher version.", "operationId":"broker::Servers::updateServers", "requestBody":{ "content":{ "application/json":{ "schema":{ "properties":{ "servers":{ "description":"Array having only one element, which is the url of the selected server for which version update is required.", "required":true, "type":"array", "items":{ "type":"string" } }, "version":{ "description":"The new version which is to be applied to the server.", "required":true, "type":"string", "example":"6.0.4" } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "type":"object", "properties":{ "message":{ "type":"string" } }, "example":{ "message":"update started" } } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-Servers-updateServers-post", "x-filename-id":"api-broker-servers-updateservers-post" } }, "/api/broker/Servers/updateServerRoles":{ "post":{ "tags":[ "Broker Control/Servers" ], "summary":"Update Server Roles", "description":"Updates the subroles for different roles of a server.
The minimum required properties in each brokerServersUpdateServerRoles item in the request body are:\n", "operationId":"broker::Servers::updateServerRoles", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/brokerServersUpdateServerRoles" } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "type":"object", "properties":{ "message":{ "type":"string" } }, "example":{ "message":"InstallRole started" } } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-Servers-updateServerRoles-post", "x-filename-id":"api-broker-servers-updateserverroles-post" } }, "/api/broker/Servers/updateEULAAcceptance":{ "put":{ "tags":[ "Broker Control/Servers" ], "summary":"Update Acceptance of EULA", "description":"Creates the end-user license agreement (EULA) acceptance file.", "operationId":"broker::Servers::updateEULAAcceptance", "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-Servers-updateEULAAcceptance-put", "x-filename-id":"api-broker-servers-updateeulaacceptance-put" } }, "/api/broker/Services":{ "get":{ "tags":[ "Broker Control/Broker Services" ], "summary":"Get Broker Services", "description":"Gets the broker services that match the specified parameters. If no parameters are specified, all broker services are returned.", "operationId":"broker::Services::read", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/brokerServicesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-Services-get", "x-filename-id":"api-broker-services-get" }, "post":{ "tags":[ "Broker Control/Broker Services" ], "summary":"Create a Broker Service", "description":"Creates a new broker service.
The minimum required properties in the request body are:\n ", "operationId":"broker::Services::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/brokerServicesCreate", "required":[ "ServerID", "ClusterID", "PrimaryServiceID", "PackageName", "ServiceName", "ServiceProgram", "ServiceDescription", "StatusID", "FailoverType", "Privileged", "ApplicationConfig" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/brokerServicesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-Services-post", "x-filename-id":"api-broker-services-post" } }, "/api/broker/Services/{id}":{ "get":{ "tags":[ "Broker Control/Broker Services" ], "summary":"Get a Broker Service by ID", "description":"Gets the broker service that matches the specified ID.", "operationId":"broker::Services::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The broker service ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/brokerServicesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-Services-{id}-get", "x-filename-id":"api-broker-services-id-get" }, "delete":{ "tags":[ "Broker Control/Broker Services" ], "summary":"Delete a Broker Service", "description":"Deletes the broker service that matches the specified ID.", "operationId":"broker::Services::delete", "parameters":[ { "name":"id", "in":"path", "description":"The broker service ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-Services-{id}-delete", "x-filename-id":"api-broker-services-id-delete" }, "put":{ "tags":[ "Broker Control/Broker Services" ], "summary":"Update a Broker Service", "description":"Updates the properties of a broker service that matches the specified ID.", "operationId":"broker::Services::update", "parameters":[ { "name":"id", "in":"path", "description":"The broker service ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/brokerServicesCreate" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/brokerServicesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-Services-{id}-put", "x-filename-id":"api-broker-services-id-put" } }, "/api/broker/Services/readForSelect":{ "get":{ "tags":[ "Broker Control/Broker Services" ], "summary":"Get Broker Services for Combo Boxes and Item Selectors", "description":"Gets broker services in a format suitable for combo boxes and item selectors.", "operationId":"broker::Services::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/brokerServicesReadForSelect" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-Services-readForSelect-get", "x-filename-id":"api-broker-services-readforselect-get" } }, "/api/broker/Services/readStates":{ "get":{ "tags":[ "Broker Control/Broker Services" ], "summary":"Get Broker Service States", "description":"Gets the states of broker services that match the specified parameters. If no parameters are specified, all broker service states are returned.", "operationId":"broker::Services::readStates", "parameters":[ { "name":"Servers", "in":"query", "description":"The array of server IDs.", "schema":{ "type":"array", "items":{ "type":"integer" } }, "example":[ 3, 5 ] } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/brokerServicesReadStates" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-Services-readStates-get", "x-filename-id":"api-broker-services-readstates-get" } }, "/api/broker/Services/executeStart":{ "get":{ "tags":[ "Broker Control/Broker Services" ], "summary":"Start a Service", "description":"Starts the service that matches the specified ID.", "operationId":"broker::Services::executeStart", "parameters":[ { "name":"id", "in":"query", "description":"The broker service ID.", "schema":{ "type":"integer" }, "example":24 } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"object", "additionalProperties":{ "type":"string", "description":"Uses the format \"ServerName/ServiceName\" as the property or key and status of the service or process as the value." }, "example":{ "server.com/testServiceName":"Process started" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-Services-executeStart-get", "x-filename-id":"api-broker-services-executestart-get" } }, "/api/broker/Services/executeStop":{ "get":{ "tags":[ "Broker Control/Broker Services" ], "summary":"Stop a Service", "description":"Stops the service that matches the specified ID.", "operationId":"broker::Services::executeStop", "parameters":[ { "name":"id", "in":"query", "description":"The broker service ID.", "schema":{ "type":"integer" }, "example":24 } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"object", "additionalProperties":{ "type":"string", "description":"Uses the format \"ServerName/ServiceName\" as the property or key and status of the service or process as the value." }, "example":{ "server.com/testServiceName":"Process stopped" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-Services-executeStop-get", "x-filename-id":"api-broker-services-executestop-get" } }, "/api/broker/Services/executeRestart":{ "get":{ "tags":[ "Broker Control/Broker Services" ], "summary":"Restart a Service", "description":"Restarts the service that matches the specified ID.", "operationId":"broker::Services::executeRestart", "parameters":[ { "name":"id", "in":"query", "description":"The broker service ID.", "schema":{ "type":"integer" }, "example":24 } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"object", "additionalProperties":{ "type":"string", "description":"Uses the format \"ServerName/ServiceName\" as the property or key and status of the service or process as the value." }, "example":{ "server.com/testServiceName":"Process restarted" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-Services-executeRestart-get", "x-filename-id":"api-broker-services-executerestart-get" } }, "/api/broker/Services/executeReloadConfig":{ "get":{ "tags":[ "Broker Control/Broker Services" ], "summary":"Reload Service Configuration", "description":"Reload the configuration of the service that matches the specified ID. Not all services support reloading configurations. In general, you can only reload configurations for daemon services, where the program name ends in d, such as the Event Email Aggregator service, which uses the Emaild program. See the documentation for each application in Unified Assurance Implementation Guide.", "operationId":"broker::Services::executeReloadConfig", "parameters":[ { "name":"id", "in":"query", "description":"The ID of the broker service to reload configurations for.", "schema":{ "type":"integer" }, "example":15 } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"object", "additionalProperties":{ "type":"string", "description":"Uses the format \"ServerName/ServiceName\" as the property or key and status of the service or process as the value." }, "example":{ "server.com/testServiceName":"App Config reload acknowledged" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-broker-Services-executeReloadConfig-get", "x-filename-id":"api-broker-services-executereloadconfig-get" } }, "/api/config/Actions":{ "get":{ "tags":[ "Device Configuration/Device Configuration Actions" ], "summary":"Get Device Configuration Actions", "description":"Gets the device configuration actions that match the specified parameters. If no parameters are specified, all device configuration actions are returned.", "operationId":"config::Actions::read", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"The list of all the device configuration actions that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/configActionsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-config-Actions-get", "x-filename-id":"api-config-actions-get" }, "post":{ "tags":[ "Device Configuration/Device Configuration Actions" ], "summary":"Create a Device Configuration Action", "description":"Creates a new device configuration action.
The minimum required properties in the request body are:\n ", "operationId":"config::Actions::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/configActionsCreate", "required":[ "ActionName", "Actions", "ResultTimeout" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new device configuration action.", "type":"array", "items":{ "$ref":"#/components/schemas/configActionsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-config-Actions-post", "x-filename-id":"api-config-actions-post" } }, "/api/config/Actions/{id}":{ "get":{ "tags":[ "Device Configuration/Device Configuration Actions" ], "summary":"Get a Device Configuration Action by ID", "description":"Gets the device configuration action that matches the specified ID.", "operationId":"config::Actions::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The device configuration action ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/configActionsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-config-Actions-{id}-get", "x-filename-id":"api-config-actions-id-get" }, "delete":{ "tags":[ "Device Configuration/Device Configuration Actions" ], "summary":"Delete a Device Configuration Action", "description":"Deletes the device configuration action that matches the specified ID.", "operationId":"config::Actions::delete", "parameters":[ { "name":"id", "in":"path", "description":"The device configuration action ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-config-Actions-{id}-delete", "x-filename-id":"api-config-actions-id-delete" }, "put":{ "tags":[ "Device Configuration/Device Configuration Actions" ], "summary":"Update a Device Configuration Action", "description":"Updates the properties of the device configuration action that matches the specified ID.", "operationId":"config::Actions::update", "parameters":[ { "name":"id", "in":"path", "description":"The device configuration action ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/configActionsCreate" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the updated device configuration action.", "type":"array", "items":{ "$ref":"#/components/schemas/configActionsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-config-Actions-{id}-put", "x-filename-id":"api-config-actions-id-put" } }, "/api/config/Actions/readForSelect":{ "get":{ "tags":[ "Device Configuration/Device Configuration Actions" ], "summary":"Get Device Configuration Actions for Combo Boxes and Item Selectors", "description":"Gets device configuration actions in a format suitable for combo boxes and item selectors.", "operationId":"config::Actions::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"The list of device configuration actions.", "type":"array", "items":{ "$ref":"#/components/schemas/configActionsReadForSelect" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-config-Actions-readForSelect-get", "x-filename-id":"api-config-actions-readforselect-get" } }, "/api/config/Collections":{ "get":{ "tags":[ "Device Configuration/Device Configuration Collections" ], "summary":"Get Device Configuration Collections", "description":"Gets the device configuration collections that match the specified parameters. If no parameters are specified, all device configuration collections are returned.", "operationId":"config::Collections::read", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"The list of all the device configuration collections that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/configCollectionsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-config-Collections-get", "x-filename-id":"api-config-collections-get" }, "post":{ "tags":[ "Device Configuration/Device Configuration Collections" ], "summary":"Create a Device Configuration Collection", "description":"Creates a new device configuration collection.
The minimum required properties in the request body are:\n ", "operationId":"config::Collections::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/configCollectionsCreate", "required":[ "ConfigAgentProfileID", "ConfigActionProfileID", "Devices", "DeviceName" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new device configuration collection.", "type":"array", "items":{ "$ref":"#/components/schemas/configCollectionsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-config-Collections-post", "x-filename-id":"api-config-collections-post" } }, "/api/config/Collections/{id}":{ "get":{ "tags":[ "Device Configuration/Device Configuration Collections" ], "summary":"Get a Device Configuration Collection by ID", "description":"Gets the device configuration collection that matches the specified ID.", "operationId":"config::Collections::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The device configuration collection ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/configCollectionsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-config-Collections-{id}-get", "x-filename-id":"api-config-collections-id-get" }, "delete":{ "tags":[ "Device Configuration/Device Configuration Collections" ], "summary":"Delete a Device Configuration Collection", "description":"Deletes the device configuration collection that matches the specified ID.", "operationId":"config::Collections::delete", "parameters":[ { "name":"id", "in":"path", "description":"The device configuration collection ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-config-Collections-{id}-delete", "x-filename-id":"api-config-collections-id-delete" }, "put":{ "tags":[ "Device Configuration/Device Configuration Collections" ], "summary":"Update a Device Configuration Collection", "description":"Updates the properties of the device configuration collection that matches the specified ID.", "operationId":"config::Collections::update", "parameters":[ { "name":"id", "in":"path", "description":"The device configuration collection ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/configCollectionsUpdate" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the updated device configuration collection.", "type":"array", "items":{ "$ref":"#/components/schemas/configCollectionsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-config-Collections-{id}-put", "x-filename-id":"api-config-collections-id-put" } }, "/api/config/Collections/readForSelect":{ "get":{ "tags":[ "Device Configuration/Device Configuration Collections" ], "summary":"Get Device Configuration Collections for Combo Boxes and Item Selectors", "description":"Gets device configuration collections in a format suitable for combo boxes and item selectors.", "operationId":"config::Collections::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"The list of device configuration collections.", "type":"array", "items":{ "$ref":"#/components/schemas/configCollectionsReadForSelect" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-config-Collections-readForSelect-get", "x-filename-id":"api-config-collections-readforselect-get" } }, "/api/config/Collections/executeRun":{ "get":{ "tags":[ "Device Configuration/Device Configuration Collections" ], "summary":"Start Config Gatherer Job for a Device", "description":"Start the Config Gatherer broker job for the device that matches the specified collection ID.", "operationId":"config::Collections::executeRun", "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-config-Collections-executeRun-get", "x-filename-id":"api-config-collections-executerun-get" } }, "/api/config/Policies":{ "get":{ "tags":[ "Device Configuration/Device Configuration Policies" ], "summary":"Get Device Configuration Policies", "description":"Gets the device configuration policies that match the specified parameters. If no parameters are specified, all device configuration policies are returned.", "operationId":"config::Policies::read", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"The list of all the device configuration policies that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/configPoliciesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-config-Policies-get", "x-filename-id":"api-config-policies-get" }, "post":{ "tags":[ "Device Configuration/Device Configuration Policies" ], "summary":"Create a Device Configuration Policy", "description":"Creates a new device configuration policy.
The minimum required properties in the request body are:\n ", "operationId":"config::Policies::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/configPoliciesCreate", "required":[ "ConfigDiscoProfileName", "StatusID", "Description", "DeviceNameRegex", "DeviceMetaTypeID", "DeviceMetaTypeValue", "ConfigAgentProfileID", "ConfigActionProfileID", "DeviceTypeID", "DeviceTypeCategoryID" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new device configuration policy.", "type":"array", "items":{ "$ref":"#/components/schemas/configPoliciesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-config-Policies-post", "x-filename-id":"api-config-policies-post" } }, "/api/config/Policies/{id}":{ "get":{ "tags":[ "Device Configuration/Device Configuration Policies" ], "summary":"Get a Device Configuration Policy by ID", "description":"Gets the device configuration policy that matches the specified ID.", "operationId":"config::Policies::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The device configuration policy ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/configPoliciesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-config-Policies-{id}-get", "x-filename-id":"api-config-policies-id-get" }, "delete":{ "tags":[ "Device Configuration/Device Configuration Policies" ], "summary":"Delete a Device Configuration Policy", "description":"Deletes the device configuration policy that matches the specified ID.", "operationId":"config::Policies::delete", "parameters":[ { "name":"id", "in":"path", "description":"The device configuration policy ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-config-Policies-{id}-delete", "x-filename-id":"api-config-policies-id-delete" }, "put":{ "tags":[ "Device Configuration/Device Configuration Policies" ], "summary":"Update a Device Configuration Policy", "description":"Updates the properties of the device configuration policy that matches the specified ID.", "operationId":"config::Policies::update", "parameters":[ { "name":"id", "in":"path", "description":"The device configuration policy ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/configPoliciesCreate" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the updated device configuration policy.", "type":"array", "items":{ "$ref":"#/components/schemas/configPoliciesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-config-Policies-{id}-put", "x-filename-id":"api-config-policies-id-put" } }, "/api/config/Policies/readForSelect":{ "get":{ "tags":[ "Device Configuration/Device Configuration Policies" ], "summary":"Get Device Configuration Policies for Combo Boxes and Item Selectors", "description":"Gets device configuration policies in a format suitable for combo boxes and item selectors.", "operationId":"config::Policies::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"The list of device configuration policies.", "type":"array", "items":{ "$ref":"#/components/schemas/configPoliciesReadForSelect" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-config-Policies-readForSelect-get", "x-filename-id":"api-config-policies-readforselect-get" } }, "/api/config/Profiles":{ "get":{ "tags":[ "Device Configuration/Device Configuration Profiles" ], "summary":"Get Device Configuration Profiles", "description":"Gets the device configuration profiles that match the specified parameters. If no parameters are specified, all device configuration profiles are returned.", "operationId":"config::Profiles::read", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"The list of all the device configuration profiles that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/configProfilesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-config-Profiles-get", "x-filename-id":"api-config-profiles-get" }, "post":{ "tags":[ "Device Configuration/Device Configuration Profiles" ], "summary":"Create a Device Configuration Profile", "description":"Creates a new device configuration profile.
The minimum required properties in the request body are:\n ", "operationId":"config::Profile::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/configProfilesCreate", "required":[ "ProfileName", "ProfileStatus", "ProfileDescription", "ProfileUser", "ProfilePassword", "NotificationProfile", "NotificationTemplate", "Message", "EmailAddresses" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new device configuration profile.", "type":"array", "items":{ "$ref":"#/components/schemas/configProfilesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-config-Profiles-post", "x-filename-id":"api-config-profiles-post" } }, "/api/config/Profiles/{id}":{ "get":{ "tags":[ "Device Configuration/Device Configuration Profiles" ], "summary":"Get a Device Configuration Profile by ID", "description":"Gets the device configuration profile that matches the specified ID.", "operationId":"config::Profiles::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The device configuration profile ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/configProfilesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-config-Profiles-{id}-get", "x-filename-id":"api-config-profiles-id-get" }, "delete":{ "tags":[ "Device Configuration/Device Configuration Profiles" ], "summary":"Delete a Device Configuration Profile", "description":"Deletes the device configuration profile that matches the specified ID.", "operationId":"config::Profiles::delete", "parameters":[ { "name":"id", "in":"path", "description":"The device configuration profile ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-config-Profiles-{id}-delete", "x-filename-id":"api-config-profiles-id-delete" }, "put":{ "tags":[ "Device Configuration/Device Configuration Profiles" ], "summary":"Update a Device Configuration Profile", "description":"Updates the properties of the device configuration profile that matches the specified ID.", "operationId":"config::Profiles::update", "parameters":[ { "name":"id", "in":"path", "description":"The device configuration profile ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/configProfilesCreate" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the updated device configuration profile.", "type":"array", "items":{ "$ref":"#/components/schemas/configProfilesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-config-Profiles-{id}-put", "x-filename-id":"api-config-profiles-id-put" } }, "/api/config/Profiles/readForSelect":{ "get":{ "tags":[ "Device Configuration/Device Configuration Profiles" ], "summary":"Get Device Configuration Profiles for Combo Boxes and Item Selectors", "description":"Gets device configuration profiles in a format suitable for combo boxes and item selectors.", "operationId":"config::Profiles::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"The list of device configuration profiles.", "type":"array", "items":{ "$ref":"#/components/schemas/configProfilesReadForSelect" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-config-Profiles-readForSelect-get", "x-filename-id":"api-config-profiles-readforselect-get" } }, "/api/config/ViewConfigs/readForSelect":{ "get":{ "tags":[ "Device Configuration/Device Configurations" ], "summary":"Get Collected Device Configuration Names for Combo Boxes and Item Selectors", "description":"Gets the collected device configuration names in a format suitable for combo boxes and item selectors.", "operationId":"config::ViewConfigs::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" }, { "name":"ConfigCollectionName", "in":"query", "description":"The configuration collection name.", "schema":{ "type":"string" }, "example":"SSH Actions" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"The list of collected device configuration names.", "type":"array", "items":{ "$ref":"#/components/schemas/configCollectionsReadForSelect" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-config-ViewConfigs-readForSelect-get", "x-filename-id":"api-config-viewconfigs-readforselect-get" } }, "/api/config/ViewConfigs/readRevisionHistory":{ "get":{ "tags":[ "Device Configuration/Device Configurations" ], "summary":"Get Revision History of a File", "description":"Gets the revision history of a file specified by either the configuration collection name or the configuration collection ID.", "operationId":"config::ViewConfigs::readRevisionHistory", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/query" }, { "name":"ConfigCollectionName", "in":"query", "description":"The configuration collection name. Provide either ConfigCollectionName or ConfigCollectionID, but not both.", "schema":{ "type":"string" }, "example":"SSH Actions" }, { "name":"ConfigCollectionID", "in":"query", "description":"The configuration collection ID. Provide either ConfigCollectionName or ConfigCollectionID, but not both.", "schema":{ "type":"integer" }, "example":"1001" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"The revision history of the specified file.", "type":"array", "items":{ "$ref":"#/components/schemas/configViewConfigsReadRevisionHistory" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-config-ViewConfigs-readRevisionHistory-get", "x-filename-id":"api-config-viewconfigs-readrevisionhistory-get" } }, "/api/config/ViewConfigs/readFile":{ "get":{ "tags":[ "Device Configuration/Device Configurations" ], "summary":"Get File Contents for Specified Configuration", "description":"Gets the file contents for the specified configuration.", "operationId":"config::ViewConfigs::readFile", "parameters":[ { "name":"ToRevision", "in":"query", "description":"The revision number to stop the action at.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" }, { "name":"ConfigCollectionName", "in":"query", "description":"The configuration collection name. Provide either ConfigCollectionName or ConfigCollectionID, but not both.", "schema":{ "type":"string" }, "example":"SSH Actions" }, { "name":"ConfigCollectionID", "in":"query", "description":"The configuration collection ID. Provide either ConfigCollectionName or ConfigCollectionID, but not both.", "schema":{ "type":"integer" }, "example":"1001" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"The file contents.", "type":"array", "items":{ "$ref":"#/components/schemas/configViewConfigsReadFile" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-config-ViewConfigs-readFile-get", "x-filename-id":"api-config-viewconfigs-readfile-get" } }, "/api/config/ViewConfigs/readDiff":{ "get":{ "tags":[ "Device Configuration/Device Configurations" ], "summary":"Get Difference between Specified Files or Revisions", "description":"Gets the difference between the specified files or revisions.", "operationId":"config::ViewConfigs::readDiff", "parameters":[ { "name":"FromRevision", "in":"query", "description":"The revision number to start the action from.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" }, { "name":"ToRevision", "in":"query", "description":"The revision number to stop the action at.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" }, { "name":"ConfigCollectionName", "in":"query", "description":"The configuration collection name. Provide either ConfigCollectionName or ConfigCollectionID, but not both.", "schema":{ "type":"string" }, "example":"SSH Actions" }, { "name":"ConfigCollectionID", "in":"query", "description":"The configuration collection ID. Provide either ConfigCollectionName or ConfigCollectionID, but not both.", "schema":{ "type":"integer" }, "example":"1001" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"The difference between the two files or revisions.", "type":"array", "items":{ "$ref":"#/components/schemas/configViewConfigsReadDiff" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-config-ViewConfigs-readDiff-get", "x-filename-id":"api-config-viewconfigs-readdiff-get" } }, "/api/config/ViewConfigs/readView":{ "get":{ "tags":[ "Device Configuration/Device Configurations" ], "summary":"Get Logs for a Device", "description":"Gets the logs for the device specified by either the configuration collection name or the configuration collection ID.", "operationId":"config::ViewConfigs::readView", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "name":"ConfigCollectionName", "in":"query", "description":"The configuration collection name. Provide either ConfigCollectionName or ConfigCollectionID, but not both.", "schema":{ "type":"string" }, "example":"SSH Actions" }, { "name":"ConfigCollectionID", "in":"query", "description":"The configuration collection ID. Provide either ConfigCollectionName or ConfigCollectionID, but not both.", "schema":{ "type":"integer" }, "example":"1001" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"The logs for the specified device.", "type":"array", "items":{ "$ref":"#/components/schemas/configViewConfigsReadView" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-config-ViewConfigs-readView-get", "x-filename-id":"api-config-viewconfigs-readview-get" } }, "/api/core/Batch/execute":{ "post":{ "tags":[ "Core/API Batches" ], "summary":"Run APIs in Batches", "description":"Runs the batch of API requests specified in the request body Actions array. At minimum, each object in the array requires the api and method properties to specify the endpoint and REST method.

\nInclude any required parameters and request body properties for the specified endpoint in the data or dynamicData properties. You do not need to specify whether a parameter belongs in the path, query, or body. You can use data for properties with static values, or you can use dynamicData for properties with both static values and values that are defined dynamically based on responses to earlier requests in the same batch. You can use both data and dynamicData in the same object, or for simplicity, you can include all properties in dynamicData. As best practices, do not repeat the same property in both data and dynamicData, and put each nested array in only one location.

\nFor example, the Update a Device endpoint requires:\n

\nFor endpoints without required parameters, such as Get Devices, you can use data or dynamicData to provide filtering and pagination query parameters. Oracle recommends using filtering and pagination for endpoints like Get Devices that could return many results. The example request body includes objects for the Get Broker Servers and Get Broker Services endpoints that use properties in data and dynamicData to limit and filter results. To include multiple filters with dynamic and static values, include the entire filters array, with both static and dynamic values, in dynamicData.

\nSee the descriptions of each endpoint in this document for required and optional parameters.

\nYou can optionally use the following properties to string requests together:\n

\nThe example for this endpoint illustrates how to use a single batch request to get a server's ID based on its host FQDN, get the list of services for that server, and update the log level for each service in the list. For annotated examples, see Examples.

\nYou can use batch files to automate configurations and reproduce settings in different environments. For example, if you want the same data in separate environments for testing or bug troubleshooting, you can use the same batch file to create the same resources in both places.", "operationId":"core::Batch::execute", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/coreBatchExecuteRequestBody" }, "example":{ "Actions":[ { "api":"broker/servers", "method":"read", "data":{ "limit":1, "filter":{ "property":"ServerHostFQDN", "value":"hostfqdn.example.com", "operator":"eq" } }, "response":{ "varName":"ServerID", "fieldName":"ServerID", "varType":"single" } }, { "api":"broker/services", "method":"read", "dynamicData":{ "ServerID":"$ServerID" }, "response":{ "varName":"ServiceIDs", "fieldName":"BrokerServiceID", "varType":"array" } }, { "api":"broker/services", "method":"update", "forEach":{ "from":"ServiceIDs", "varName":"ServiceID" }, "data":{ "ApplicationConfig":{ "BrokerApplicationConfigTypeID":2, "BrokerApplicationConfigName":"LogLevel", "BrokerApplicationConfigValue":4, "Required":1 } }, "dynamicData":{ "id":"$ServiceID" } } ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/coreBatchExecuteResponseBody" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-core-Batch-execute-post", "x-filename-id":"api-core-batch-execute-post" } }, "/api/core/CertificateWarning":{ "get":{ "tags":[ "Core/Certificate Warning" ], "summary":"Get Global Setting for Certificate Warning", "description":"Gets the global properties related to certificate warnings, primarily to make the user aware of the possible expiry of the certificate. If the property value is returned as 1, certificate warning is displayed on the user interface.", "operationId":"core::CertificateWarning::read", "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/coreGlobalPropertiesCertificateWarning" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-core-CertificateWarning-get", "x-filename-id":"api-core-certificatewarning-get" } }, "/api/core/ChangePassword/executeChangePassword":{ "post":{ "tags":[ "Core/User Sessions" ], "summary":"Change a Password", "description":"Changes the password as specified in the request body. All request body properties are required.", "operationId":"core::ChangePassword::executeChangePassword", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/coreExecuteChangePasswordRequestBody" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/SessionInfoRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-core-ChangePassword-executeChangePassword-post", "x-filename-id":"api-core-changepassword-executechangepassword-post" } }, "/api/core/GlobalProperties":{ "get":{ "tags":[ "Core/Global Properties" ], "summary":"Get Global Properties", "description":"Gets the global properties that match the specified parameters. If no parameters are specified, all global properties are returned.", "operationId":"core::GlobalProperties::read", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/coreGlobalPropertiesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-core-GlobalProperties-get", "x-filename-id":"api-core-globalproperties-get" } }, "/api/core/GlobalProperties/{id}":{ "get":{ "tags":[ "Core/Global Properties" ], "summary":"Get a Global Property by ID", "description":"Uses global property id as a path parameter to fetch details of a particular global property only.", "operationId":"Core::GlobalProperties::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"Global Property ID", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/coreGlobalPropertiesRead" } }, "total":{ "description":"The total number of results regardless of paging", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-core-GlobalProperties-{id}-get", "x-filename-id":"api-core-globalproperties-id-get" }, "put":{ "tags":[ "Core/Global Properties" ], "summary":"Update a Global Property", "description":"Updates the global property that matches the specified ID.", "operationId":"core::GlobalProperties::update", "parameters":[ { "name":"id", "in":"path", "description":"The global property ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "PropertyValue":{ "description":"The property value.", "type":"integer", "example":"1" } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/coreGlobalPropertiesRead" } }, "total":{ "description":"The total number of results regardless of paging", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-core-GlobalProperties-{id}-put", "x-filename-id":"api-core-globalproperties-id-put" } }, "/api/core/Icons":{ "post":{ "tags":[ "Core/Icons" ], "summary":"Create an Icon", "description":"Creates a new icon from an uploaded image.", "operationId":"core::Icons::create", "requestBody":{ "content":{ "image/jpeg":{ "schema":{ "properties":{ "filename":{ "description":"The file name.", "type":"string", "example":"filename.jpg" } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-core-Icons-post", "x-filename-id":"api-core-icons-post" } }, "/api/core/Icons/readForSelect":{ "get":{ "tags":[ "Core/Icons" ], "summary":"Get Icons for Combo Boxes and Item Selectors", "description":"Gets icons in a format suitable for combo boxes and item selectors.", "operationId":"core::Icons::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"The list of icons.", "type":"array", "items":{ "$ref":"#/components/schemas/coreIcons" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-core-Icons-readForSelect-get", "x-filename-id":"api-core-icons-readforselect-get" } }, "/api/core/Locales/read/{LocaleValue}":{ "get":{ "tags":[ "Core/Locales" ], "summary":"Get Locale Information", "description":"Gets information about the locale that matches the specified ID. The ID corresponds to the LocaleName returned by the Get Locales for Combo Boxes and Item Selectors endpoint. The default en_US locale is ignored and will return no data.", "operationId":"core::Locales::read", "parameters":[ { "name":"LocaleValue", "in":"path", "description":"The ID of the locale.", "required":true, "schema":{ "type":"string" }, "example":"en_DEBUG" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/coreLocalesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-core-Locales-read-{LocaleValue}-get", "x-filename-id":"api-core-locales-read-localevalue-get" } }, "/api/core/Locales/readForSelect":{ "get":{ "tags":[ "Core/Locales" ], "summary":"Get Locales for Combo Boxes and Item Selectors", "description":"Gets locales in a format suitable for combo boxes and item selectors.", "operationId":"core::Locales::readForSelect", "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"The list of locales.", "type":"array", "items":{ "$ref":"#/components/schemas/coreLocalesReadForSelect" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-core-Locales-readForSelect-get", "x-filename-id":"api-core-locales-readforselect-get" } }, "/api/core/Login/executeLogin":{ "post":{ "tags":[ "Core/User Sessions" ], "summary":"Log In and Authenticate a User", "description":"Logs in the user with the specified user name and password.", "operationId":"core::Login::executeLogin", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "Username":{ "description":"The user name.", "type":"string", "example":"admin", "required":true }, "Password":{ "description":"The password.", "type":"string", "example":"password", "required":true } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/SessionInfoRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-core-Login-executeLogin-post", "x-filename-id":"api-core-login-executelogin-post" } }, "/api/core/Login/executeLogout":{ "post":{ "tags":[ "Core/User Sessions" ], "summary":"Log a User Out", "description":"Logs out the user with the specified user name or ID. Either Username or UserID is required.", "operationId":"core::Login::executeLogout", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "Username":{ "description":"The user name.", "type":"string", "example":"admin" }, "UserID":{ "description":"The user ID.", "type":"integer", "example":"1" } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "message":{ "type":"string", "description":"The response message.", "example":"Logout Successful" }, "data":{ "type":"array", "items":{ } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-core-Login-executeLogout-post", "x-filename-id":"api-core-login-executelogout-post" } }, "/api/core/Login/readSessionInfo":{ "get":{ "tags":[ "Core/User Sessions" ], "summary":"Get Session Data", "description":"Gets the session data.", "operationId":"core::Login::readSessionInfo", "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"The session data.", "type":"array", "items":{ "allOf":[ { "$ref":"#/components/schemas/SessionInfoRead" }, { "type":"object", "properties":{ "BaseDir":{ "description":"The base directory.", "type":"string", "example":"/bin/directory" } } } ] } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-core-Login-readSessionInfo-get", "x-filename-id":"api-core-login-readsessioninfo-get" } }, "/api/core/Login/readSessionInfoJs":{ "get":{ "tags":[ "Core/User Sessions" ], "summary":"Get Session Data as JSON File", "description":"Gets the session data as a JSON file.", "operationId":"core::Login::readSessionInfoJs", "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"The session data as a JSON file.", "type":"array", "items":{ "allOf":[ { "$ref":"#/components/schemas/SessionInfoRead" }, { "type":"object", "properties":{ "BaseDir":{ "description":"The base directory.", "type":"string", "example":"/bin/directory" } } } ] } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-core-Login-readSessionInfoJs-get", "x-filename-id":"api-core-login-readsessioninfojs-get" } }, "/api/core/Themes/readForSelect":{ "get":{ "tags":[ "Core/Themes" ], "summary":"Get Themes for Combo Boxes and Item Selectors", "description":"Gets themes in a format suitable for combo boxes and item selectors.", "operationId":"core::Theme::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/coreThemes" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-core-Themes-readForSelect-get", "x-filename-id":"api-core-themes-readforselect-get" } }, "/api/core/TimeZones/readForSelect":{ "get":{ "tags":[ "Core/Time Zones" ], "summary":"Get Database Time Zones for Combo Boxes and Item Selectors", "description":"Gets database time zones in a format suitable for combo boxes and item selectors.", "operationId":"core::TimeZones::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/query" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"The list of database time zones.", "type":"array", "items":{ "$ref":"#/components/schemas/coreTimeZones" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-core-TimeZones-readForSelect-get", "x-filename-id":"api-core-timezones-readforselect-get" } }, "/api/dashboard/Dashboards/{id}":{ "get":{ "tags":[ "Dashboard/Dashboards" ], "summary":"Get a Dashboard by ID", "description":"Gets the dashboard that matches the specified ID.", "operationId":"dashboard::Dashboards::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The dashboard ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/dashboardDashboardsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-dashboard-Dashboards-{id}-get", "x-filename-id":"api-dashboard-dashboards-id-get" }, "put":{ "tags":[ "Dashboard/Dashboards" ], "summary":"Update a Dashboard", "description":"Updates the properties of the dashboard that matches the specified ID.", "operationId":"dashboard::Dashboards::update", "parameters":[ { "name":"id", "in":"path", "description":"The dashboard ID.", "required":true, "schema":{ "type":"integer", "format":"int32" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/dashboardDashboards" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the updated dashboard.", "type":"array", "items":{ "$ref":"#/components/schemas/dashboardDashboardsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-dashboard-Dashboards-{id}-put", "x-filename-id":"api-dashboard-dashboards-id-put" }, "delete":{ "tags":[ "Dashboard/Dashboards" ], "summary":"Delete a Dashboard", "description":"Deletes the dashboard that matches the specified ID.", "operationId":"dashboard::Dashboards::delete", "parameters":[ { "name":"id", "in":"path", "description":"The dashboard ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-dashboard-Dashboards-{id}-delete", "x-filename-id":"api-dashboard-dashboards-id-delete" } }, "/api/dashboard/Dashboards":{ "get":{ "tags":[ "Dashboard/Dashboards" ], "summary":"Get Dashboards", "description":"Gets the dashboards that match the specified parameters. If no parameters are specified, all dashboards are returned.", "operationId":"dashboard::Dashboards::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of dashboards that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/dashboardDashboardsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-dashboard-Dashboards-get", "x-filename-id":"api-dashboard-dashboards-get" }, "post":{ "tags":[ "Dashboard/Dashboards" ], "summary":"Create a Dashboard", "description":"Creates a new dashboard.
The minimum required properties in the request body are:\n

", "operationId":"dashboards::Dashboards::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/dashboardDashboards", "required":[ "DashboardName", "OwnerUserID", "OwnerUserGroupID", "Viewers", "PanelParams" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new dashboard.", "type":"array", "items":{ "$ref":"#/components/schemas/dashboardDashboardsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-dashboard-Dashboards-post", "x-filename-id":"api-dashboard-dashboards-post" } }, "/api/dashboard/Dashboards/readParts":{ "get":{ "tags":[ "Dashboard/Dashboards" ], "summary":"Get Dashboard Part Configurations", "description":"Gets dashboard part configurations. Parts is the internal name for the dashboard panel types.", "operationId":"dashboard::Dashboards::readParts", "parameters":[ { "$ref":"#/components/parameters/query" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of dashboard part configurations.", "type":"array", "items":{ "$ref":"#/components/schemas/dashboardDashboardsReadParts" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-dashboard-Dashboards-readParts-get", "x-filename-id":"api-dashboard-dashboards-readparts-get" } }, "/api/dashboard/Dashboards/readForSelect":{ "get":{ "tags":[ "Dashboard/Dashboards" ], "summary":"Get Dashboards for Combo Boxes and Item Selectors", "description":"Gets dashboards in a format suitable for combo boxes and item selectors.", "operationId":"dashboard::Dashboards::readForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/query" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of dashboards.", "type":"array", "items":{ "$ref":"#/components/schemas/dashboardDashboardsReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-dashboard-Dashboards-readForSelect-get", "x-filename-id":"api-dashboard-dashboards-readforselect-get" } }, "/api/dashboard/Dashboards/createImportDashboard":{ "post":{ "tags":[ "Dashboard/Dashboards" ], "summary":"Create a Dashboard from a JSON File", "description":"Creates a new dashboard from an imported JSON file. The UploadFile parameter is required.", "operationId":"dashboard::Dashboards::createImportDashboard", "requestBody":{ "content":{ "multipart/form-data":{ "schema":{ "type":"object", "properties":{ "UploadFile":{ "description":"The JSON file to be uploaded. This file is created by exporting an existing dashboard. This option is designed to facilitate copying dashboards between servers.", "type":"string", "format":"binary", "required":true } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new dashboard created from the imported JSON file.", "type":"array", "items":{ "$ref":"#/components/schemas/dashboardDashboardsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-dashboard-Dashboards-createImportDashboard-post", "x-filename-id":"api-dashboard-dashboards-createimportdashboard-post" } }, "/api/dashboard/Dashboards/readExportDashboard":{ "get":{ "tags":[ "Dashboard/Dashboards" ], "summary":"Get a JSON String Representation of a Dashboard", "description":"Gets the JSON string representation of the dashboard that matches the specified ID.", "operationId":"dashboard::Dashboards::readExportDashboard", "parameters":[ { "name":"DashboardID", "in":"query", "required":true, "description":"The dashboard ID required for the export.", "schema":{ "type":"integer", "example":26 } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "description":"The JSON file to be saved.", "type":"object", "properties":{ "DashboardName":{ "description":"The dashboard name.", "type":"string", "example":"Basic Services Dashboard" }, "OwnerUserID":{ "description":"The UserID of the dashboard owner.", "type":"integer", "example":"0" }, "OwnerUserGroupID":{ "description":"The UserGroupID of the dashboard owner.", "type":"integer", "example":"0" }, "DashboardTypeID":{ "description":"The dashboard type ID. \n\nAllowed values are: \n - 1 = Basic \n - 2 = Adhoc", "type":"integer", "example":"1" }, "PanelParams":{ "description":"The configuration information for the dashboard panels.", "type":"string", "example":"[{\"PartTypeID\":\"6\",\"width\":100,\"DashboardName\":\"Basic Services Dashboard\",\"InitialExpansion\":\"0\",\"InitialExpansionDynamic\":\"1\",\"InitialView\":\"Summary\",\"InitialViewDynamic\":\"1\",\"LinkTarget\":\"NewWindow\",\"LinkTargetDynamic\":\"1\",\"PanelName\":\"Test\",\"PartTypeID\":\"6\",\"RefreshRate\":\"\",\"RootID\":\"root\",\"RootIDDynamic\":\"1\",\"ShowToolbar\":\"1\",\"SummaryInitialExpansion\":\"all\",\"SummaryInitialExpansionDynamic\":\"1\",\"SummaryNodeSize\":\"Normal\",\"SummaryNodeSizeDynamic\":\"1\",\"SummaryTreeType\":\"LeftToRight\",\"SummaryTreeTypeDynamic\":\"1\",\"TimeRangeDynamic\":\"1\",\"TimeRange\":\"now-24h..now..\",\"Width\":\"1\",\"recordID\":\"DashboardsDashboard\",\"width\":\"1\",\"AutoHeight\":1}]" }, "HideHeader":{ "description":"Indicates if the header should be shown when the dashboard is rendered.", "type":"integer", "example":"0" }, "ReloadRate":{ "description":"The time interval in seconds in which the dashboard will automatically refresh all panel content. Null indicates the dashboard does not auto refresh.", "type":"integer", "nullable":true, "example":null }, "MaxColumns":{ "description":"The maximum number of columns the dashboard will render before wrapping additional panels onto the next row.", "type":"integer", "example":"4" }, "Viewers":{ "description":"The list of user groups that can view the dashboard.", "type":"array", "items":{ "type":"object", "properties":{ "UserGroupID":{ "description":"The user group ID.", "type":"integer" }, "UserGroupName":{ "description":"The user group name.", "type":"string" } } }, "example":[ ] } } } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-dashboard-Dashboards-readExportDashboard-get", "x-filename-id":"api-dashboard-dashboards-readexportdashboard-get" } }, "/api/dashboard/DashboardGroups/{id}":{ "get":{ "tags":[ "Dashboard/Dashboard Groups" ], "summary":"Get a Dashboard Group by ID", "description":"Gets the dashboard group that matches the specified ID.", "operationId":"dashboard::DashboardGroups::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The dashboard group ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" }, { "name":"readChildren", "in":"query", "description":"Whether to show tree display or form display.\nAllowed values:\n", "required":false, "schema":{ "type":"boolean" }, "example":false } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/dashboardDashboardGroupsReadByID" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-dashboard-DashboardGroups-{id}-get", "x-filename-id":"api-dashboard-dashboardgroups-id-get" }, "put":{ "tags":[ "Dashboard/Dashboard Groups" ], "summary":"Update a Dashboard Group", "description":"Updates the properties of the dashboard group that matches the specified ID.", "operationId":"dashboard::DashboardGroups::update", "parameters":[ { "name":"id", "in":"path", "description":"The dashboard group ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/dashboardDashboardGroups" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "$ref":"#/components/schemas/dashboardDashboardGroupsReadByID" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-dashboard-DashboardGroups-{id}-put", "x-filename-id":"api-dashboard-dashboardgroups-id-put" }, "delete":{ "tags":[ "Dashboard/Dashboard Groups" ], "summary":"Delete a Dashboard Group", "description":"Deletes the dashboard group that matches the specified ID. A dashboard group cannot be deleted if it is currently set as the restrictive dashboard group for a user or user group. The root group can never be deleted.", "operationId":"dashboard::DashboardGroups::delete", "parameters":[ { "name":"id", "in":"path", "description":"The dashboard group ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-dashboard-DashboardGroups-{id}-delete", "x-filename-id":"api-dashboard-dashboardgroups-id-delete" } }, "/api/dashboard/DashboardGroups":{ "get":{ "tags":[ "Dashboard/Dashboard Groups" ], "summary":"Get Dashboard Groups for Tree Grids or Form Grids", "description":"Gets the dashboard groups for the tree grid or the form grid.", "operationId":"dashboard::DashboardGroups::read", "parameters":[ { "name":"node", "description":"The node of the tree to get. You can specify root or the numerical ID.", "in":"query", "required":true, "schema":{ "type":"string", "example":"root" } }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of dashboard groups.", "type":"array", "items":{ "$ref":"#/components/schemas/dashboardDashboardGroupsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-dashboard-DashboardGroups-get", "x-filename-id":"api-dashboard-dashboardgroups-get" }, "post":{ "tags":[ "Dashboard/Dashboard Groups" ], "summary":"Create a Dashboard Group", "description":"Creates a new dashboard group.
The minimum required properties in the request body are:\n ", "operationId":"dashboard::DashboardGroups::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/dashboardDashboardGroups", "required":[ "DashboardGroupName", "Dashboards" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new dashboard group.", "type":"array", "items":{ "$ref":"#/components/schemas/dashboardDashboardGroupsReadByID" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-dashboard-DashboardGroups-post", "x-filename-id":"api-dashboard-dashboardgroups-post" } }, "/api/dashboard/DashboardGroups/readForTree":{ "get":{ "tags":[ "Dashboard/Dashboard Groups" ], "summary":"Get Dashboard Groups for Tree Grids", "description":"Gets the dashboard groups in a format suitable for tree grids.", "operationId":"dashboard::DashboardGroups::readForTree", "parameters":[ { "name":"node", "description":"The node of the tree to get. You can specify root or the numerical ID.", "in":"query", "required":true, "schema":{ "type":"string" }, "example":"root" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of dashboard groups.", "type":"array", "items":{ "$ref":"#/components/schemas/dashboardDashboardGroupsReadForTree" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-dashboard-DashboardGroups-readForTree-get", "x-filename-id":"api-dashboard-dashboardgroups-readfortree-get" } }, "/api/dashboard/DashboardGroups/updateMove":{ "put":{ "tags":[ "Dashboard/Dashboard Groups" ], "summary":"Move Dashboard Groups to a Different Parent", "description":"Moves the dashboard groups listed in id to the parent specified in ParentDashboard.", "operationId":"dashboard::DashboardGroups::updateMove", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "id":{ "description":"The comma-separated list of dashboard group IDs.", "type":"integer", "example":"28", "required":true }, "ParentDashboardGroupID":{ "$ref":"#/components/schemas/dashboardDashboardGroupsReadByID/properties/ParentDashboardGroupID", "required":true } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "$ref":"#/components/schemas/dashboardDashboardGroupsReadByID" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-dashboard-DashboardGroups-updateMove-put", "x-filename-id":"api-dashboard-dashboardgroups-updatemove-put" } }, "/api/dashboard/DashboardGroups/updateDashboards":{ "put":{ "tags":[ "Dashboard/Dashboard Groups" ], "summary":"Move or Copy Dashboards to a Different Group", "description":"Moves or copies dashboards to a different group. To move, specify a source group in SourceDashboardGroupID. To copy, do not specify a source group. This endpoint only applies to dashboards already in a dashboard group.", "operationId":"dashboard::DashboardGroups::updateDashboards", "requestBody":{ "content":{ "application/json":{ "schema":{ "required":[ "id", "Dashboards" ], "type":"object", "properties":{ "id":{ "description":"The destination dashboard group ID.", "type":"integer", "example":"28" }, "SourceDashboardGroupID":{ "description":"The source dashboard group ID. To move dashboards, specify an ID. To copy dashboards, do not use this parameter.", "type":"integer" }, "Dashboards":{ "$ref":"#/components/schemas/dashboardDashboardGroupsReadByID/properties/Dashboards" } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "$ref":"#/components/schemas/dashboardDashboardGroupsReadByID" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-dashboard-DashboardGroups-updateDashboards-put", "x-filename-id":"api-dashboard-dashboardgroups-updatedashboards-put" } }, "/api/dashboardNavigation/Dashboards/readForTree":{ "get":{ "tags":[ "Dashboard/Dashboard Navigation" ], "summary":"Get Dashboards and Dashboard Groups Under a Specific Node", "description":"Gets dashboards and dashboard groups under a specific node.", "operationId":"dashboardNavigation::Dashboards::readForTree", "parameters":[ { "name":"node", "description":"The node of the tree to get. You can specify root, the numerical id, or the full tree path.", "in":"query", "required":true, "schema":{ "type":"string", "example":"root" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of dashboards and dashboard groups.", "type":"array", "items":{ "allOf":[ { "type":"object", "properties":{ "id":{ "description":"The dashboard ID.", "type":"integer" }, "DashboardGroupID":{ "description":"The dashboard group ID.", "type":"integer" }, "text":{ "description":"The name of the dashboard group or dashboard.", "type":"string" }, "expanded":{ "description":"Whether expanded or not.", "type":"boolean" } } }, { "type":"object", "properties":{ "text":{ "description":"The name of the dashboard group or dashboard.", "type":"string" }, "leaf":{ "description":"Indicates whether this is a leaf node in a hierarchy or not.", "type":"boolean" }, "iconCls":{ "description":"The CSS class for icons.", "type":"string" }, "view":{ "description":"The REST path to load the dashboard.", "type":"string" }, "DashboardID":{ "description":"The dashboard ID.", "type":"integer" }, "DashboardName":{ "description":"The dashboard name.", "type":"string" } } } ] }, "example":[ { "id":"1002", "DashboardGroupID":"1002", "text":"Adhoc - Copy", "expanded":false }, { "text":"Adhoc Event Dashboard", "leaf":true, "iconCls":"icon-portal", "view":"#event/events/eventsAdhocView", "DashboardID":"28", "DashboardName":"Adhoc Event Dashboard" } ] } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-dashboardNavigation-Dashboards-readForTree-get", "x-filename-id":"api-dashboardnavigation-dashboards-readfortree-get" } }, "/api/database/Databases/{id}":{ "get":{ "tags":[ "Database/Databases" ], "summary":"Get a Database by ID", "description":"Gets the database that matches the specified ID.", "operationId":"database::Databases::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The database ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The database properties.", "type":"array", "items":{ "$ref":"#/components/schemas/databaseDatabasesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-database-Databases-{id}-get", "x-filename-id":"api-database-databases-id-get" }, "put":{ "tags":[ "Database/Databases" ], "summary":"Update a Database", "description":"Updates the properties of the database that matches the specified ID.", "operationId":"database::Databases::update", "parameters":[ { "name":"id", "in":"path", "description":"The database ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/databaseDatabases" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The properties of the updated database.", "type":"array", "items":{ "$ref":"#/components/schemas/databaseDatabasesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-database-Databases-{id}-put", "x-filename-id":"api-database-databases-id-put" }, "delete":{ "tags":[ "Database/Databases" ], "summary":"Delete a Database", "description":"Deletes the database that matches the specified ID.", "operationId":"database::Databases::delete", "parameters":[ { "name":"id", "in":"path", "description":"The database ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":2 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-database-Databases-{id}-delete", "x-filename-id":"api-database-databases-id-delete" } }, "/api/database/Databases":{ "get":{ "tags":[ "Database/Databases" ], "summary":"Get Databases", "description":"Gets the databases that match the specified parameters. If no parameters are specified, all databases are returned.", "operationId":"database::Databases::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of databases that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/databaseDatabasesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-database-Databases-get", "x-filename-id":"api-database-databases-get" }, "post":{ "tags":[ "Database/Databases" ], "summary":"Create a Database", "description":"Creates a new database.
The minimum required properties in the request body are:\n ", "operationId":"database::Databases::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/databaseDatabases", "required":[ "ShardID", "FailoverTypeID", "DatabaseName", "DBType", "DBHost", "DBName", "DBPort", "StatusID", "Timeout", "Password", "Username" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The properties of the new database.", "type":"array", "items":{ "$ref":"#/components/schemas/databaseDatabasesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-database-Databases-post", "x-filename-id":"api-database-databases-post" } }, "/api/database/Databases/readForSelect":{ "get":{ "tags":[ "Database/Databases" ], "summary":"Get Databases for Combo Boxes and Item Selectors", "description":"Gets databases in a format suitable for combo boxes and item selectors.", "operationId":"database::Databases::readForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/query" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":1 }, "data":{ "description":"The list of databases.", "type":"array", "items":{ "type":"object", "properties":{ "DatabaseID":{ "description":"The database ID.", "type":"integer", "example":"1002" }, "DatabaseName":{ "description":"The database display name.", "type":"string", "example":"Primary Graph Database on someone.example.com" } } } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-database-Databases-readForSelect-get", "x-filename-id":"api-database-databases-readforselect-get" } }, "/api/database/Databases/readStates":{ "get":{ "tags":[ "Database/Databases" ], "summary":"Get States of Databases Based on DatabaseWatchdog", "description":"Gets the states of the databases that match the specified parameters based on DatabaseWatchdog. If the database is not running, the state defaults to Unknown.", "operationId":"database::Databases::readStates", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":1 }, "data":{ "description":"The list of databases with their states.", "type":"array", "items":{ "$ref":"#/components/schemas/databaseDatabasesReadStates" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-database-Databases-readStates-get", "x-filename-id":"api-database-databases-readstates-get" } }, "/api/database/Databases/readSchemasForSelect":{ "get":{ "tags":[ "Database/Databases" ], "summary":"Get Database Schemas for Combo Boxes and Item Selectors", "description":"Gets database schemas in a format suitable for combo boxes and item selectors.", "operationId":"database::Databases::readSchemasForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/query" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":1 }, "data":{ "description":"The list of database schemas.", "type":"array", "items":{ "type":"object", "properties":{ "DBName":{ "description":"The database schema name.", "type":"string" } } }, "example":[ { "DBName":"Event" }, { "DBName":"Metric" }, { "DBName":"Graph" } ] } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-database-Databases-readSchemasForSelect-get", "x-filename-id":"api-database-databases-readschemasforselect-get" } }, "/api/database/Queries/{id}":{ "get":{ "tags":[ "Database/Database Queries" ], "summary":"Get a Query by ID", "description":"Gets the query that matches the specified ID.", "operationId":"database::Queries::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The query ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The query properties.", "type":"array", "items":{ "$ref":"#/components/schemas/databaseQueriesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-database-Queries-{id}-get", "x-filename-id":"api-database-queries-id-get" }, "put":{ "tags":[ "Database/Database Queries" ], "summary":"Update a Query", "description":"Updates the properties of the query that matches the specified ID.", "operationId":"database::Queries::update", "parameters":[ { "name":"id", "in":"path", "description":"The query ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/databaseQueries" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The properties of the updated query.", "type":"array", "items":{ "$ref":"#/components/schemas/databaseQueriesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-database-Queries-{id}-put", "x-filename-id":"api-database-queries-id-put" }, "delete":{ "tags":[ "Database/Database Queries" ], "summary":"Delete a Query", "description":"Deletes the query that matches the specified ID.", "operationId":"database::Queries::delete", "parameters":[ { "name":"id", "in":"path", "description":"The query ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":2 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-database-Queries-{id}-delete", "x-filename-id":"api-database-queries-id-delete" } }, "/api/database/Queries":{ "get":{ "tags":[ "Database/Database Queries" ], "summary":"Get Queries", "description":"Gets the queries that match the specified parameters. If no parameters are specified, all queries are returned.", "operationId":"database::Queries::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of queries that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/databaseQueriesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-database-Queries-get", "x-filename-id":"api-database-queries-get" }, "post":{ "tags":[ "Database/Database Queries" ], "summary":"Create a Query", "description":"Creates a new query.
The minimum required properties in the request body are:\n ", "operationId":"database::Queries::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/databaseQueries", "required":[ "QueryName", "QueryDBName", "Query", "OwnerUserID", "OwnerUserGroupID", "Tokens" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The properties of the new query.", "type":"array", "items":{ "$ref":"#/components/schemas/databaseQueriesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-database-Queries-post", "x-filename-id":"api-database-queries-post" } }, "/api/database/Queries/readForSelect":{ "get":{ "tags":[ "Database/Database Queries" ], "summary":"Get Queries for Combo Boxes and Item Selectors", "description":"Gets queries in a format suitable for combo boxes and item selectors.", "operationId":"database::Queries::readForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/query" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":1 }, "data":{ "description":"The list of queries.", "type":"array", "items":{ "$ref":"#/components/schemas/databaseQueriesReadForSelect" }, "example":[ { "QueryID":"1000", "QueryName":"Devices Missing DNS" }, { "QueryID":"1002", "QueryName":"Devices set to Disabled" }, { "QueryID":"1003", "QueryName":"Devices with SNMP SysName & DNS Mismatch" } ] } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-database-Queries-readForSelect-get", "x-filename-id":"api-database-queries-readforselect-get" } }, "/api/database/Queries/readTokens":{ "get":{ "tags":[ "Database/Database Queries" ], "summary":"Get All Tokens of a Query", "description":"Gets all the tokens of a query that matches the specified ID. The specified query must already have tokens for a successful result.", "operationId":"database::Queries::readTokens", "parameters":[ { "name":"id", "in":"query", "description":"The query ID.", "required":true, "schema":{ "type":"integer", "example":1001 } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":1 }, "data":{ "description":"The list of tokens of the specified query.", "type":"array", "items":{ "type":"object", "properties":{ "TokenName":{ "description":"The token name.", "type":"string", "example":"Zone" }, "TokenIndex":{ "description":"The token index.", "type":"integer", "example":"1" }, "DefaultValue":{ "description":"The default value for the token.", "type":"integer", "example":"1" } } } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-database-Queries-readTokens-get", "x-filename-id":"api-database-queries-readtokens-get" } }, "/api/database/QueryTools/executeQuery":{ "post":{ "tags":[ "Database/Database Query Tools" ], "summary":"Run a Query", "description":"Runs the query that matches the specified parameters. At minimum, the QueryDBName property is required in the request body.", "operationId":"database::QueryTools::executeQuery", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/databaseQueryTools", "required":[ "QueryDBName" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"2" }, "data":{ "description":"The DNS name, IP address and device zone ID of the query that was run.", "type":"array", "items":{ "$ref":"#/components/schemas/databaseQueryToolsResponseData" }, "example":[ { "DNSName":"someone.example.com", "IPAddress":"1682824301", "DeviceZoneID":"1" }, { "DNSName":"testing", "IPAddress":"1682824301", "DeviceZoneID":"1" } ] }, "metaData":{ "description":"The meta data for the received list.", "type":"object", "properties":{ "root":{ "example":"data" }, "columns":{ "description":"An array of information describing how the columns should be presented.", "type":"array", "items":{ "type":"object", "properties":{ "header":{ "example":"DNSName" }, "dataIndex":{ "example":"DNSName" }, "filter":{ "example":"string" }, "flex":{ "example":1 }, "minWidth":{ "example":100 } } } }, "fields":{ "description":"An array of column header descriptions.", "type":"array", "items":{ "type":"string" } } }, "example":"{\n \"root\": \"data\",\n \"columns\": {\n \"header\": \"DNSName\",\n \"dataIndex\": \"DNSName\",\n \"filter\": \"string\",\n \"flex\": \"1\",\n \"minWidth\": \"100\"\n },\n {\n \"header\": \"IPAddress\",\n \"dataIndex\": \"IPAddress\",\n \"filter\": \"int\",\n \"flex\": \"1\",\n \"minWidth\": \"100\"\n },\n {\n \"header\": \"DeviceZoneID\",\n \"dataIndex\": \"DeviceZoneID\",\n \"filter\": \"int\",\n \"flex\": \"1\",\n \"minWidth\": \"100\"\n },\n \"fields\": [\n \"DNSName\",\n \"IPAddress\",\n \"DeviceZoneID\"\n ]\n}" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-database-QueryTools-executeQuery-post", "x-filename-id":"api-database-querytools-executequery-post" } }, "/api/device/Devices/{id}":{ "get":{ "tags":[ "Device Catalog/Devices" ], "summary":"Get a Device by ID", "description":"Gets the device that matches the specified ID.", "operationId":"device::Devices::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The device ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"The device properties.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceDevicesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Devices-{id}-get", "x-filename-id":"api-device-devices-id-get" }, "put":{ "tags":[ "Device Catalog/Devices" ], "summary":"Update a Device", "description":"Updates the properties of the device that matches the specified ID.", "operationId":"device::Devices::update", "parameters":[ { "name":"id", "in":"path", "description":"The device ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/deviceDevices" } } } }, "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulUpdateResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Devices-{id}-put", "x-filename-id":"api-device-devices-id-put" }, "delete":{ "tags":[ "Device Catalog/Devices" ], "summary":"Delete a Device", "description":"Deletes the device that matches the specified ID.", "operationId":"device::Devices::delete", "parameters":[ { "name":"id", "in":"path", "description":"The device ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":2 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Devices-{id}-delete", "x-filename-id":"api-device-devices-id-delete" } }, "/api/device/Devices":{ "get":{ "tags":[ "Device Catalog/Devices" ], "summary":"Get Devices", "description":"Gets the devices that match the specified parameters. If no parameters are specified, all devices are returned. Oracle recommends using filtering and pagination parameters to limit the results.", "operationId":"device::Devices::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "name":"excludeMetadata", "in":"query", "description":"Whether to include device information only (true) or device information and meta tags (false). The default is false. If you have a high number of devices with meta tags, setting this to false may result in slow response times.", "required":false, "schema":{ "type":"boolean" }, "example":true } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of devices that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceDevicesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Devices-get", "x-filename-id":"api-device-devices-get" }, "post":{ "tags":[ "Device Catalog/Devices" ], "summary":"Create a Device", "description":"Creates a new device.\n
For physical devices, at minimum, you must specify either the Custom Name, DNS Name, IPv4 or IPv6 address.\n
For virtual devices, IP address and DNS name are not used. Only Custom Name and Parent Device are required.\n
The minimum required properties in the request body are:\n \n Note: Previously, either IPv4 or IPv6 was required. These have been deprecated. Use IPAddress or IPv6Address instead.", "operationId":"device::Devices::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/deviceDevices", "required":[ "DeviceStateID", "DNSName", "IPv4", "IPAddress", "IPv6", "IPv6Address", "DevicePriorityID", "DeviceZoneID", "DeviceTypeCategoryID", "ShardID", "MetaData" ] } } } }, "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulAddResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Devices-post", "x-filename-id":"api-device-devices-post" } }, "/api/device/Devices/readForSelect":{ "get":{ "tags":[ "Device Catalog/Devices" ], "summary":"Get Devices for Combo Boxes and Item Selectors", "description":"Gets devices in a format suitable for combo boxes and item selectors.", "operationId":"device::Devices::readForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/query" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":1 }, "data":{ "description":"The list of devices.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceDevicesReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Devices-readForSelect-get", "x-filename-id":"api-device-devices-readforselect-get" } }, "/api/device/Devices/readIpForDns":{ "get":{ "tags":[ "Device Catalog/Devices" ], "summary":"Get an IP Address for a DNS Name", "description":"Gets the IPv4 or IPv6 address for the specified DNS name.", "operationId":"device::Devices::readIpForDns", "parameters":[ { "name":"DNSName", "in":"query", "description":"The DNS name to get the IP address for.", "required":true, "schema":{ "type":"string", "example":"router1.example.com" } }, { "name":"Type", "in":"query", "description":"The type of IP address to get. Valid values are IPv4 and IPv6.", "required":true, "schema":{ "type":"string", "example":"IPv4" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "message":{ "description":"The response message.", "type":"string", "example":"" }, "data":{ "description":"The IP address for the specified DNS name.", "type":"string", "example":"192.0.2.1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Devices-readIpForDns-get", "x-filename-id":"api-device-devices-readipfordns-get" } }, "/api/device/Categories/{id}":{ "get":{ "tags":[ "Device Catalog/Device Type Categories" ], "summary":"Get a Device Type Category by ID", "description":"Gets the device type category that matches the specified ID.", "operationId":"device::Categories::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The device type category ID.", "required":true, "schema":{ "type":"integer", "example":"1" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/deviceCategoriesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Categories-{id}-get", "x-filename-id":"api-device-categories-id-get" }, "put":{ "tags":[ "Device Catalog/Device Type Categories" ], "summary":"Update a Device Type Category", "description":"Updates the properties of the device type category that matches the specified ID.", "operationId":"device::Categories::update", "parameters":[ { "name":"id", "in":"path", "description":"The device type category ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/deviceCategories" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the updated device type category.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceCategoriesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Categories-{id}-put", "x-filename-id":"api-device-categories-id-put" }, "delete":{ "tags":[ "Device Catalog/Device Type Categories" ], "summary":"Delete a Device Type Category", "description":"Deletes the device type category that matches the specified ID.", "operationId":"device::Categories::delete", "parameters":[ { "name":"id", "in":"path", "description":"The device type category ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Categories-{id}-delete", "x-filename-id":"api-device-categories-id-delete" } }, "/api/device/Categories":{ "get":{ "tags":[ "Device Catalog/Device Type Categories" ], "summary":"Get Device Type Categories", "description":"Gets the device type categories that match the specified parameters. If no parameters are specified, all device type categories are returned.", "operationId":"device::Categories::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of all the device type categories that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceCategoriesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Categories-get", "x-filename-id":"api-device-categories-get" }, "post":{ "tags":[ "Device Catalog/Device Type Categories" ], "summary":"Create a Device Type Category", "description":"Creates a new device type category.
The minimum required properties in the request body are:\n ", "operationId":"device::Categories::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/deviceCategories", "required":[ "DeviceTypeCategoryName", "ImageName" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new device type category.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceCategoriesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Categories-post", "x-filename-id":"api-device-categories-post" } }, "/api/device/Categories/delete":{ "post":{ "tags":[ "Device Catalog/Device Type Categories" ], "summary":"Delete Multiple Device Type Categories", "description":"Deletes multiple device type categories by providing the category IDs.", "operationId":"device::Categories::deleteMultiple", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "description":"The list of device type category IDs.", "type":"object", "properties":{ "DeviceTypeCategoryID":{ "type":"integer", "example":"2" } } }, "example":"{\n \"DeviceTypeCategoryID\": \"1\",\n \"DeviceTypeCategoryID\": \"2\"\n}" } } } }, "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Categories-delete-post", "x-filename-id":"api-device-categories-delete-post" } }, "/api/device/Categories/readForSelect":{ "get":{ "tags":[ "Device Catalog/Device Type Categories" ], "summary":"Get Device Type Categories for Combo Boxes and Item Selectors", "description":"Gets device type categories in a format suitable for combo boxes and item selectors.", "operationId":"device::Categories::readForSelect", "parameters":[ { "name":"id", "in":"query", "required":false, "description":"Either the DeviceTypeCategoryID or the DeviceTypeCategoryName of the device type category to get. Returns only results that match the specified ID exactly.", "schema":{ "oneOf":[ { "type":"integer" }, { "type":"string" } ] } }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "name":"query", "in":"query", "description":"The DeviceTypeCategoryName of the device type category to get. Returns results that are similar to the specified name.", "required":false, "schema":{ "type":"string" } }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of device type categories.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceCategoriesReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Categories-readForSelect-get", "x-filename-id":"api-device-categories-readforselect-get" } }, "/api/device/Groups/{id}":{ "get":{ "tags":[ "Device Catalog/Device Groups" ], "summary":"Get a Device Group by ID", "description":"Gets the device group that matches the specified ID.", "operationId":"device::Groups::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The device group ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":2 } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/deviceGroupsReadById" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Groups-{id}-get", "x-filename-id":"api-device-groups-id-get" }, "put":{ "tags":[ "Device Catalog/Device Groups" ], "summary":"Update a Device Group", "description":"Updates the properties of the device group that matches the specified ID.", "operationId":"device::Groups::update", "parameters":[ { "name":"id", "in":"path", "description":"The device group ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":2 } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/deviceGroups" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the updated device group.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceGroupsReadById" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Groups-{id}-put", "x-filename-id":"api-device-groups-id-put" }, "delete":{ "tags":[ "Device Catalog/Device Groups" ], "summary":"Delete a Device Group", "description":"Deletes the device group that matches the specified ID.", "operationId":"device::Groups::delete", "parameters":[ { "name":"id", "in":"path", "description":"The device group ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":2 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Groups-{id}-delete", "x-filename-id":"api-device-groups-id-delete" } }, "/api/device/Groups":{ "get":{ "tags":[ "Device Catalog/Device Groups" ], "summary":"Get a Device Group or Children of a Device Group", "description":"Gets the details of a device group and its children.", "operationId":"device::Groups::read", "parameters":[ { "name":"node", "in":"query", "required":true, "description":"The node of the device group to select from the tree.", "schema":{ "type":"string", "example":"root" } }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"The details of the device group.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceGroupsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Groups-get", "x-filename-id":"api-device-groups-get" }, "post":{ "tags":[ "Device Catalog/Device Groups" ], "summary":"Create a Device Group", "description":"Creates a new device group.
The minimum required properties in the request body are:\n ", "operationId":"device::Groups::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/deviceGroups" } ], "required":[ "DeviceGroupName", "ParentDeviceGroupID", "Devices" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new device group.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceGroupsReadById" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Groups-post", "x-filename-id":"api-device-groups-post" } }, "/api/device/Groups/updateDevices":{ "put":{ "tags":[ "Device Catalog/Device Groups" ], "summary":"Move or Copy Devices to a Different Group", "description":"Moves or copies devices to a different group. To move, specify a source group in SourceDeviceGroupID. To copy, do not specify a source group.", "operationId":"device::Groups::updateDevices", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "id" ], "properties":{ "id":{ "description":"The destination device group ID.", "type":"integer" }, "SourceDeviceGroupID":{ "description":"The source device group ID. To move devices, specify an ID. To copy devices, do not use this parameter.", "type":"integer" }, "Devices":{ "$ref":"#/components/schemas/deviceGroups/properties/Devices" } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The destination device group with the moved or copied devices.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceGroupsReadById" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Groups-updateDevices-put", "x-filename-id":"api-device-groups-updatedevices-put" } }, "/api/device/Groups/updateMove":{ "put":{ "tags":[ "Device Catalog/Device Groups" ], "summary":"Move Device Groups to a Different Parent", "description":"Moves the device groups listed in id to the parent specified in ParentDeviceGroupId.", "operationId":"device::Groups::updateMove", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "id":{ "description":"The comma-separated list of device group IDs.", "type":"string" }, "ParentDeviceGroupID":{ "$ref":"#/components/schemas/deviceGroups/properties/ParentDeviceGroupID" } }, "required":[ "id", "ParentDeviceGroupID" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "success":{ "description":"Whether the operation was a success (true) or a failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message text.", "type":"string", "example":"Updated record(s)" }, "data":{ "description":"The properties of the parent device group.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceGroupsReadById" } } } } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Groups-updateMove-put", "x-filename-id":"api-device-groups-updatemove-put" } }, "/api/device/Groups/readForTree":{ "get":{ "tags":[ "Device Catalog/Device Groups" ], "summary":"Get Device Groups for Tree Grids", "description":"Gets the device groups in a format suitable for tree grids.", "operationId":"device::Groups::readForTree", "parameters":[ { "name":"node", "in":"query", "description":"The node of the tree to get. You can specify root, the numerical ID, or the full tree path.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"The list of device groups.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceGroupsReadForTree" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Groups-readForTree-get", "x-filename-id":"api-device-groups-readfortree-get" } }, "/api/device/Groups/readForTreeCombo":{ "get":{ "tags":[ "Device Catalog/Device Groups" ], "summary":"Get Device Groups for Tree Combos", "description":"Gets the device groups in a format suitable for tree combos.", "operationId":"device::Groups::readForTreeCombo", "parameters":[ { "name":"node", "in":"query", "description":"The node of the tree to get. You can specify root, the numerical ID, or the full tree path.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"The list of device groups.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceGroupsReadForTree" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Groups-readForTreeCombo-get", "x-filename-id":"api-device-groups-readfortreecombo-get" } }, "/api/device/DeviceManagement/updateCategory":{ "post":{ "tags":[ "Device Catalog/Device Management" ], "summary":"Update Device Type Category by ID", "description":"Updates all devices in the device type category that matches the specified ID.
The minimum required properties in the request body are:\n ", "operationId":"device::Management::updateCategory", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "DeviceTypeCategoryID" ], "properties":{ "DeviceTypeCategoryID":{ "description":"The device type category ID to update.", "type":"integer", "example":"1", "required":true }, "Devices":{ "description":"The comma-separated list of device IDs to be updated. Either Devices or DeviceGroupID parameter is required.", "type":"integer" }, "DeviceGroupID":{ "description":"The ID of the device group from which the devices are to be updated. Either Devices or DeviceGroupID parameter is required.", "type":"integer" }, "RecursiveGroup":{ "description":"Whether all the descending devices from the device group specified by DeviceGroupID are being updated (true) or not (false).", "type":"boolean" } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SuccessfulUpdateOperation" } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-DeviceManagement-updateCategory-post", "x-filename-id":"api-device-devicemanagement-updatecategory-post" } }, "/api/device/DeviceManagement/updateDiscovery":{ "post":{ "tags":[ "Device Catalog/Device Management" ], "summary":"Update Device State ID", "description":"Updates the state ID of devices to force rediscovery on the next SNMP run. At minimum, either the DeviceGroupID or Devices property is required in the request body.", "operationId":"device::Management::updateDiscovery", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "Devices":{ "description":"The comma-separated list of device IDs whose state IDs are to be updated. Either Devices or DeviceGroupID parameter is required.", "type":"integer" }, "DeviceGroupID":{ "description":"The ID of the device group containing the devices whose state IDs are to be updated. Either Devices or DeviceGroupID parameter is required.", "type":"integer" }, "RecursiveGroup":{ "description":"Whether the state IDs of all the descending devices from the device group specified by DeviceGroupID are being updated (true) or not (false).", "type":"boolean" } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SuccessfulUpdateOperation" } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-DeviceManagement-updateDiscovery-post", "x-filename-id":"api-device-devicemanagement-updatediscovery-post" } }, "/api/device/DeviceManagement/updatePriority":{ "post":{ "tags":[ "Device Catalog/Device Management" ], "summary":"Update Device Priority ID", "description":"Update the priority ID of devices.
The minimum required properties in the request body are:\n ", "operationId":"device::Management::updatePriority", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "PriorityID":{ "description":"The priority ID to update.", "type":"integer", "example":"1", "required":true }, "Devices":{ "description":"The comma-separated list of device IDs whose priority IDs are to be updated. Either Devices or DeviceGroupID parameter is required.", "type":"integer" }, "DeviceGroupID":{ "description":"The ID of the device group containing the devices whose priority IDs are to be updated. Either Devices or DeviceGroupID parameter is required.", "type":"integer" }, "RecursiveGroup":{ "description":"Whether the priority IDs of all the descending devices from the device group specified by DeviceGroupID are being updated (true) or not (false).", "type":"boolean" } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SuccessfulUpdateOperation" } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-DeviceManagement-updatePriority-post", "x-filename-id":"api-device-devicemanagement-updatepriority-post" } }, "/api/device/DeviceManagement/updateZone":{ "post":{ "tags":[ "Device Catalog/Device Management" ], "summary":"Update Device Zone ID", "description":"Updates the zone ID of devices.
The minimum required properties in the request body are:\n ", "operationId":"device::Management::updateZone", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "DeviceZoneID":{ "description":"The device zone ID to update.", "type":"integer", "example":"1", "required":true }, "Devices":{ "description":"The comma-separated list of device IDs whose zone IDs are to be updated. Either Devices or DeviceGroupID parameter is required.", "type":"integer" }, "DeviceGroupID":{ "description":"The ID of the device group containing the devices whose zone IDs are to be updated. Either Devices or DeviceGroupID parameter is required.", "type":"integer" }, "RecursiveGroup":{ "description":"Whether the zone IDs of all the descending devices from the device group specified by DeviceGroupID are being updated (true) or not (false).", "type":"boolean" } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SuccessfulUpdateOperation" } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-DeviceManagement-updateZone-post", "x-filename-id":"api-device-devicemanagement-updatezone-post" } }, "/api/device/DeviceManagement/updateShard":{ "post":{ "tags":[ "Device Catalog/Device Management" ], "summary":"Update Device Shard ID", "description":"Update the shard ID of devices.
The minimum required properties in the request body are:\n ", "operationId":"device::Management::updateShard", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "ShardID":{ "description":"The shard ID to update.", "type":"integer", "example":"1", "required":true }, "Devices":{ "description":"The comma-separated list of device IDs whose shard IDs are to be updated. Either Devices or DeviceGroupID parameter is required.", "type":"integer" }, "DeviceGroupID":{ "description":"The ID of the device group containing the devices whose shard IDs are to be updated. Either Devices or DeviceGroupID parameter is required.", "type":"integer" }, "RecursiveGroup":{ "description":"Whether the shard IDs of all the descending devices from the device group specified by DeviceGroupID are being updated (true) or not (false).", "type":"boolean" } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SuccessfulUpdateOperation" } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-DeviceManagement-updateShard-post", "x-filename-id":"api-device-devicemanagement-updateshard-post" } }, "/api/device/DeviceManagement/updateUnmanageDevice":{ "post":{ "tags":[ "Device Catalog/Device Management" ], "summary":"Update Device State ID to Unmanage a Device", "description":"Unmanages the specified device by setting the device state ID to static. At minimum, either the DeviceGroupID or Devices property is required in the request body.", "operationId":"device::Management::updateUnmanageDevice", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "Devices":{ "description":"The comma-separated list of device IDs to unmanage. Either Devices or DeviceGroupID parameter is required.", "type":"integer" }, "DeviceGroupID":{ "description":"The ID of the device group containing the devices to be unmanaged. Either Devices or DeviceGroupID parameter is required.", "type":"integer" }, "RecursiveGroup":{ "description":"Whether all the descending devices from the device group specified by DeviceGroupID are being unmanaged (true) or not (false).", "type":"boolean" } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "message":{ "example":"Unmanaged record" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-DeviceManagement-updateUnmanageDevice-post", "x-filename-id":"api-device-devicemanagement-updateunmanagedevice-post" } }, "/api/device/DeviceManagement/deleteDevice":{ "post":{ "tags":[ "Device Catalog/Device Management" ], "summary":"Delete Multiple Devices", "description":"Deletes multiple devices. At minimum, either the DeviceGroupID or Devices property is required in the request body.", "operationId":"device::Management::deleteDevice", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "Devices":{ "description":"The comma-separated list of device IDs to delete. Either Devices or DeviceGroupID parameter is required.", "type":"integer" }, "DeviceGroupID":{ "description":"The ID of the device group containing the devices to be deleted. Either Devices or DeviceGroupID parameter is required.", "type":"integer" }, "RecursiveGroup":{ "description":"Whether all the descending devices from the device group specified by DeviceGroupID are being deleted (true) or not (false).", "type":"boolean" } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "message":{ "example":"Deleted record" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-DeviceManagement-deleteDevice-post", "x-filename-id":"api-device-devicemanagement-deletedevice-post" } }, "/api/device/MetaData/readForSelect":{ "get":{ "tags":[ "Device Catalog/Device Metadata" ], "summary":"Get Device Metadata for Combo Boxes and Item Selectors", "description":"Gets the device metadata in a format suitable for combo boxes and item selectors.", "operationId":"device::MetaData::readForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "name":"query", "in":"query", "description":"A text string to search device meta data for. Returns results that are similar to the string.", "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of device metadata.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceMetaDataReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-MetaData-readForSelect-get", "x-filename-id":"api-device-metadata-readforselect-get" } }, "/api/device/MetaTypes/{id}":{ "get":{ "tags":[ "Device Catalog/Device Metatypes" ], "summary":"Get a Device Metatype by ID", "description":"Gets the device metatype that matches the specified ID.", "operationId":"device::MetaTypes::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The device metatype ID.", "required":true, "schema":{ "type":"integer", "format":"int32" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/deviceMetaTypesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-MetaTypes-{id}-get", "x-filename-id":"api-device-metatypes-id-get" }, "put":{ "tags":[ "Device Catalog/Device Metatypes" ], "summary":"Update a Device Metatype", "description":"Updates the properties of the device metatype that matches the specified ID.", "operationId":"device::MetaTypes::update", "parameters":[ { "name":"id", "in":"path", "description":"The device metatype ID.", "required":true, "schema":{ "type":"integer", "format":"int32" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/deviceMetaTypes" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the updated device metatype.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceMetaTypesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-MetaTypes-{id}-put", "x-filename-id":"api-device-metatypes-id-put" }, "delete":{ "tags":[ "Device Catalog/Device Metatypes" ], "summary":"Delete a Device Metatype", "description":"Deletes the device metatype that matches the specified ID.", "operationId":"device::MetaTypes::delete", "parameters":[ { "name":"id", "in":"path", "description":"The device metatype ID.", "required":true, "schema":{ "type":"integer", "format":"int32" } } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-MetaTypes-{id}-delete", "x-filename-id":"api-device-metatypes-id-delete" } }, "/api/device/MetaTypes":{ "get":{ "tags":[ "Device Catalog/Device Metatypes" ], "summary":"Get Device Metatypes", "description":"Gets the device metatypes that match the specified parameters. If no parameters are specified, all device metatypes are returned.", "operationId":"device::MetaTypes::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of all the device metatypes that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceMetaTypesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-MetaTypes-get", "x-filename-id":"api-device-metatypes-get" }, "post":{ "tags":[ "Device Catalog/Device Metatypes" ], "summary":"Create a Device Metatype", "description":"Creates a new device metatype.
The minimum required properties in the request body are:\n ", "operationId":"device::MetaTypes::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/deviceMetaTypes", "required":[ "DeviceMetaTypeName", "RenderTypeID" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new device metatype.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceMetaTypesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-MetaTypes-post", "x-filename-id":"api-device-metatypes-post" } }, "/api/device/MetaTypes/readForSelect":{ "get":{ "tags":[ "Device Catalog/Device Metatypes" ], "summary":"Get Device Metatypes for Combo Boxes and Item Selectors", "description":"Gets device metatypes in a format suitable for combo boxes and item selectors.", "operationId":"device::MetaTypes::readForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "name":"query", "in":"query", "description":"The DeviceMetaTypeName of the device meta types to get. Returns results that are similar to the specified name.", "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of device metatypes.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceMetaTypesReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-MetaTypes-readForSelect-get", "x-filename-id":"api-device-metatypes-readforselect-get" } }, "/api/device/MetaTypes/readForSelectActive":{ "get":{ "tags":[ "Device Catalog/Device Metatypes" ], "summary":"Get Active Device Metatypes for Combo Boxes and Item Selectors", "description":"Gets device metatypes in a format suitable for combo boxes and item selectors based on what is active.", "operationId":"device::MetaTypes::readForSelectActive", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "name":"query", "in":"query", "description":"The DeviceMetaTypeName of the device meta types to get. Returns results that are similar to the specified name.", "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of active device metatypes.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceMetaTypesReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-MetaTypes-readForSelectActive-get", "x-filename-id":"api-device-metatypes-readforselectactive-get" } }, "/api/device/MetaTypes/readAssignedForSelect":{ "get":{ "tags":[ "Device Catalog/Device Metatypes" ], "summary":"Get Assigned Device Metatypes for Combo Boxes and Item Selectors", "description":"Gets device metatypes in a format suitable for combo boxes and item selectors based on what is assigned.", "operationId":"device::MetaTypes::readAssignedForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "name":"query", "in":"query", "description":"The DeviceMetaTypeName of the device meta types to get. Returns results that are similar to the specified name.", "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of assigned device metatypes.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceMetaTypesReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-MetaTypes-readAssignedForSelect-get", "x-filename-id":"api-device-metatypes-readassignedforselect-get" } }, "/api/device/Remote":{ "post":{ "tags":[ "Device Catalog/Device Remote" ], "summary":"Authenticate with Apache Guacamole", "description":"Authenticates with Apache Guacamole using encrypted JSON data. If the caller has already authenticated a session with the server, this API will use the username from the session. Otherwise, it will use the Guacamole default user.
\n
The minimum required properties in the request body are:\n ", "operationId":"device::Remote::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/deviceRemote", "required":[ "Node", "DeviceID", "Type" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "success":{ "description":"Whether the request was successful (true) or not (false).", "type":"boolean", "example":true }, "message":{ "description":"The response message.", "type":"string", "example":"Successfully authenticated with Guacamole, and set up connection." }, "data":{ "description":"The connection record.", "type":"object", "properties":{ "token":{ "description":"The Guacamole token used for establishing remote session.", "type":"string", "example":"28E1E03CD50E7BBF748DBD330F53B49ECAEE766F221BCBC18AAE3363C6FD23CD" }, "expires":{ "description":"The time when the token expires, in epoch seconds.", "type":"integer", "example":"1695385820000" }, "connectionID":{ "description":"The connection ID.", "type":"integer", "example":"0" }, "guacHomeUrl":{ "description":"The Guacamole home URL.", "type":"string", "example":"/go/remote/#/?token=28E1E03CD50E7BBF748DBD330F53B49ECAEE766F221BCBC18AAE3363C6FD23CD" }, "directConnectUrl":{ "description":"The URL for the UI to redirect to the authenticated remote session.", "type":"string", "example":"/go/remote/#/client/MABjAHF1aWNrY29ubmVjdA?token=28E1E03CD50E7BBF748DBD330F53B49ECAEE766F221BCBC18AAE3363C6FD23CD" } } } } } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Remote-post", "x-filename-id":"api-device-remote-post" } }, "/api/device/Types/{id}":{ "get":{ "tags":[ "Device Catalog/Device Types" ], "summary":"Get a Device Type by ID", "description":"Gets the device type that matches the specified ID.", "operationId":"device::Types::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The OID for the device type to get, prefixed with id-.", "required":true, "schema":{ "type":"string", "example":"id-1.3.6.1.4.1.3955.1.1" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/deviceTypesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Types-{id}-get", "x-filename-id":"api-device-types-id-get" }, "put":{ "tags":[ "Device Catalog/Device Types" ], "summary":"Update a Device Type", "description":"Updates the properties of the device type that matches the specified ID.", "operationId":"device::Types::update", "parameters":[ { "name":"id", "in":"path", "description":"The OID for the device type to update, prefixed with id-.", "required":true, "schema":{ "type":"string", "example":"id-1.3.6.1.4.1.3955.1.1" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/deviceTypes" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the updated device type.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceTypesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Types-{id}-put", "x-filename-id":"api-device-types-id-put" }, "delete":{ "tags":[ "Device Catalog/Device Types" ], "summary":"Delete a Device Type", "description":"Deletes the device type that matches the specified ID.", "operationId":"device::Types::delete", "parameters":[ { "name":"id", "in":"path", "description":"The OID for the device type to delete, prefixed with id-.", "required":true, "schema":{ "type":"string", "example":"id-1.3.6.1.4.1.3955.1.1" } } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Types-{id}-delete", "x-filename-id":"api-device-types-id-delete" } }, "/api/device/Types":{ "get":{ "tags":[ "Device Catalog/Device Types" ], "summary":"Get Device Types", "description":"Gets the device types that match the specified parameters. If no parameters are specified, all device types are returned.", "operationId":"device::Types::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of all the device types that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceTypesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Types-get", "x-filename-id":"api-device-types-get" }, "post":{ "tags":[ "Device Catalog/Device Types" ], "summary":"Create a Device Type", "description":"Creates a new device type.
The minimum required properties in the request body are:\n ", "operationId":"device::Types::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/deviceTypes" } ], "required":[ "SysObjectID", "DeviceTypeName", "DeviceTypeVendorID", "DeviceTypeCategoryID" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new device type.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceTypesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Types-post", "x-filename-id":"api-device-types-post" } }, "/api/device/Types/readForSelect":{ "get":{ "tags":[ "Device Catalog/Device Types" ], "summary":"Get Device Types for Combo Boxes and Item Selectors", "description":"Gets device types in a format suitable for combo boxes and item selectors.", "operationId":"device::Types::readForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "name":"query", "in":"query", "description":"The DeviceTypeName of the device types to get. Returns results that are similar to the specified name.", "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of device types.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceTypesReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Types-readForSelect-get", "x-filename-id":"api-device-types-readforselect-get" } }, "/api/device/Vendors/{id}":{ "get":{ "tags":[ "Device Catalog/Device Type Vendors" ], "summary":"Get a Device Type Vendor by ID", "description":"Gets the device type vendor that matches the specified ID.", "operationId":"device::Vendors::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The device type vendor ID.", "required":true, "schema":{ "type":"integer", "example":2 } }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/deviceVendorsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Vendors-{id}-get", "x-filename-id":"api-device-vendors-id-get" }, "put":{ "tags":[ "Device Catalog/Device Type Vendors" ], "summary":"Update a Device Type Vendor", "description":"Updates the properties of the device type vendor that matches the specified ID.", "operationId":"device::Vendors::update", "parameters":[ { "name":"id", "in":"path", "description":"The device type vendor ID.", "required":true, "schema":{ "type":"integer", "example":2 } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/deviceVendorsRead" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the updated device type vendor.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceVendorsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Vendors-{id}-put", "x-filename-id":"api-device-vendors-id-put" }, "delete":{ "tags":[ "Device Catalog/Device Type Vendors" ], "summary":"Delete a Device Type Vendor", "description":"Deletes the device type vendor that matches the specified ID.", "operationId":"device::Vendors::delete", "parameters":[ { "name":"id", "in":"path", "description":"The device type vendor ID.", "required":true, "schema":{ "type":"integer", "example":2 } } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Vendors-{id}-delete", "x-filename-id":"api-device-vendors-id-delete" } }, "/api/device/Vendors":{ "get":{ "tags":[ "Device Catalog/Device Type Vendors" ], "summary":"Get Device Type Vendors", "description":"Gets the device type vendors that match the specified parameters. If no parameters are specified, all device type vendors are returned.", "operationId":"device::Vendors::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of all the device type vendors that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceVendorsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Vendors-get", "x-filename-id":"api-device-vendors-get" }, "post":{ "tags":[ "Device Catalog/Device Type Vendors" ], "summary":"Create a Device Type Vendor", "description":"Creates a new device type vendor. At minimum, the DeviceTypeVendorName property is required in the request body.", "operationId":"device::Vendors::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/deviceVendors" } ], "required":[ "DeviceTypeVendorName" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new device type vendor.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceVendorsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Vendors-post", "x-filename-id":"api-device-vendors-post" } }, "/api/device/Vendors/readForSelect":{ "get":{ "tags":[ "Device Catalog/Device Type Vendors" ], "summary":"Get Device Type Vendors for Combo Boxes and Item Selectors", "description":"Gets device type vendors in a format suitable for combo boxes and item selectors.", "operationId":"device::Vendors::readForSelect", "parameters":[ { "name":"id", "in":"query", "description":"Either the DeviceTypeVendorID or the DeviceTypeVendorName of the device type vendor to get. Returns only results that match the specified ID exactly.", "required":false, "schema":{ "type":"integer" } }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "name":"query", "in":"query", "description":"The DeviceTypeVendorName of the device type vendor to get. Returns results that are similar to the specified name.", "required":false, "schema":{ "type":"string" } }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of device type vendors.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceVendorsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Vendors-readForSelect-get", "x-filename-id":"api-device-vendors-readforselect-get" } }, "/api/device/DeviceViews":{ "get":{ "tags":[ "Device Catalog/Device Views" ], "summary":"Get Device Details", "description":"Gets the details of the specified device.
An example path with query parameters is:\n
/api/device/DeviceViews?DeviceName=router.example.com;z3&DetailLevel=Minimal", "operationId":"device::DeviceViews::read", "parameters":[ { "name":"DeviceName", "description":"A serialized device name or comma-separated list of serialized device names. Only used if the DeviceSource parameter is set to Device or MultipleDevices.", "in":"query", "required":true, "schema":{ "type":"string", "example":"router.example.com;z1 OR router.example.com" } }, { "name":"DeviceZoneID", "in":"query", "description":"The ID of the device zone to get performance data for. Deprecated. Use serialized device name instead.", "schema":{ "type":"integer" }, "example":"1" }, { "name":"DetailLevel", "description":"The level of detail to retrieve. Use Minimal to retrieve only the device name or Full to retrieve all the information on the device. The default value is Full.", "in":"query", "required":false, "schema":{ "type":"string", "example":"Minimal", "enum":[ "Minimal", "Full" ] } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of details of the specified device.", "type":"array", "items":{ "oneOf":[ { "$ref":"#/components/schemas/deviceDeviceViews" }, { "$ref":"#/components/schemas/deviceDeviceViewsFull" } ] }, "example":[ { "PropertyName":"Device Name", "PropertyValue":"router.example.com" }, { "PropertyName":"Timestamp Added", "PropertyValue":"2022-10-27 07:23:09" }, { "PropertyName":"Timestamp Modified", "PropertyValue":"2023-05-16 22:30:26" }, { "PropertyName":"IP Address", "PropertyValue":"192.0.2.1" }, { "PropertyName":"IPv6 Address", "PropertyValue":null }, { "PropertyName":"Device ID", "PropertyValue":"43" }, { "PropertyName":"Custom Name", "PropertyValue":"" }, { "PropertyName":"DNS Name", "PropertyValue":"example.com" }, { "PropertyName":"Sys Name", "PropertyValue":"dev1-col2" }, { "PropertyName":"Sys OID", "PropertyValue":"1.2.3.4" }, { "PropertyName":"Description", "PropertyValue":"Linux router 1.2.3.4x86_64 #2 SMP Tue Jan 18 13:44:44 PST 2022 x86_64" }, { "PropertyName":"Location", "PropertyValue":"Unknown" }, { "PropertyName":"Contact", "PropertyValue":"root@localhost" }, { "PropertyName":"Services", "PropertyValue":"0" }, { "PropertyName":"IP Forwarding", "PropertyValue":"1" }, { "PropertyName":"Serial Number", "PropertyValue":"" }, { "PropertyName":"Device Type Name", "PropertyValue":"Linux" }, { "PropertyName":"Device Type Category", "PropertyValue":"Appliance" }, { "PropertyName":"GeoLocation", "PropertyValue":"{\"type\": \"Point\", \"coordinates\": [0.0, 0.0]}" } ] } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-DeviceViews-get", "x-filename-id":"api-device-deviceviews-get" } }, "/api/device/Windows/{id}":{ "get":{ "tags":[ "Device Catalog/Device Maintenance Windows" ], "summary":"Get a Device Maintenance Window by ID", "description":"Gets the device maintenance window that matches the specified ID.", "operationId":"device::Windows::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The device maintenance window ID.", "required":true, "schema":{ "type":"integer", "format":"int32" } }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/deviceWindowsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Windows-{id}-get", "x-filename-id":"api-device-windows-id-get" }, "put":{ "tags":[ "Device Catalog/Device Maintenance Windows" ], "summary":"Update a Device Maintenance Window", "description":"Updates the properties of the device maintenance window that matches the specified ID.", "operationId":"device::Windows::update", "parameters":[ { "name":"id", "in":"path", "description":"The device maintenance window ID.", "required":true, "schema":{ "type":"integer", "format":"int32" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/deviceWindows" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the updated device maintenance window.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceWindowsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Windows-{id}-put", "x-filename-id":"api-device-windows-id-put" }, "delete":{ "tags":[ "Device Catalog/Device Maintenance Windows" ], "summary":"Delete a Device Maintenance Window", "description":"Deletes the device maintenance window that matches the specified ID.", "operationId":"device::Windows::delete", "parameters":[ { "name":"id", "in":"path", "description":"The device maintenance window ID.", "required":true, "schema":{ "type":"integer", "format":"int32" } } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Windows-{id}-delete", "x-filename-id":"api-device-windows-id-delete" } }, "/api/device/Windows":{ "get":{ "tags":[ "Device Catalog/Device Maintenance Windows" ], "summary":"Get Device Maintenance Windows", "description":"Gets the device maintenance windows that match the specified parameters. If no parameters are specified, all device maintenance windows are returned.", "operationId":"device::Windows::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of all the device maintenance windows that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceWindowsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Windows-get", "x-filename-id":"api-device-windows-get" }, "post":{ "tags":[ "Device Catalog/Device Maintenance Windows" ], "summary":"Create a Device Maintenance Window", "description":"Creates a new device maintenance window.
The minimum required properties in the request body are:\n ", "operationId":"device::Windows::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/deviceWindows" } ], "required":[ "WindowName", "StartTime", "StopTime", "Devices" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new device maintenance window.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceWindowsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Windows-post", "x-filename-id":"api-device-windows-post" } }, "/api/device/Windows/readForSelect":{ "get":{ "tags":[ "Device Catalog/Device Maintenance Windows" ], "summary":"Get Device Maintenance Windows for Combo Boxes and Item Selectors", "description":"Gets device maintenance windows in a format suitable for combo boxes and item selectors.", "operationId":"device::Windows::readForSelect", "parameters":[ { "name":"id", "in":"query", "description":"Either the WindowID (integer) or the WindowName (string) of the device maintenance window to get. Returns only results that match the specified ID exactly.", "required":false, "schema":{ "oneOf":[ { "type":"integer" }, { "type":"string" } ] } }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "name":"query", "in":"query", "description":"The WindowName of the device maintenance window to get. Returns results that are similar to the specified name.", "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of device maintenance windows.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceWindowsReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Windows-readForSelect-get", "x-filename-id":"api-device-windows-readforselect-get" } }, "/api/device/Zones/{id}":{ "get":{ "tags":[ "Device Catalog/Device Zones" ], "summary":"Get a Device Zone by ID", "description":"Gets the device zone that matches the specified ID.", "operationId":"device::Zones::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The device zone ID.", "required":true, "schema":{ "type":"integer", "example":1 } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The device zone properties.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceZonesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Zones-{id}-get", "x-filename-id":"api-device-zones-id-get" }, "put":{ "tags":[ "Device Catalog/Device Zones" ], "summary":"Update a Device Zone", "description":"Updates the properties of the device zone that matches the specified ID.", "operationId":"device::Zones::update", "parameters":[ { "name":"id", "in":"path", "description":"The device zone ID.", "required":true, "schema":{ "type":"integer", "example":1 } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "DeviceZoneName" ], "properties":{ "DeviceZoneName":{ "description":"The new name for the device zone. It must have at least one letter and cannot be entirely numbers.", "type":"string", "example":"Default First Zone" } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the updated device zone.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceZonesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Zones-{id}-put", "x-filename-id":"api-device-zones-id-put" }, "delete":{ "tags":[ "Device Catalog/Device Zones" ], "summary":"Delete a Device Zone", "description":"Deletes the device zone that matches the specified ID.", "operationId":"device::Zones::delete", "parameters":[ { "name":"id", "in":"path", "description":"The device zone ID.", "required":true, "schema":{ "type":"integer", "example":2 } } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Zones-{id}-delete", "x-filename-id":"api-device-zones-id-delete" } }, "/api/device/Zones":{ "get":{ "tags":[ "Device Catalog/Device Zones" ], "summary":"Get Device Zones", "description":"Gets the device zones that match the specified parameters. If no parameters are specified, all device zones are returned.", "operationId":"device::Zones::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of device zones that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceZonesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Zones-get", "x-filename-id":"api-device-zones-get" }, "post":{ "tags":[ "Device Catalog/Device Zones" ], "summary":"Create a Device Zone", "description":"Creates a new device zone. At minimum, the DeviceZoneName property is required in the request body.", "operationId":"device::Zones::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "DeviceZoneName" ], "properties":{ "DeviceZoneID":{ "description":"The device zone ID assigned for the new device zone. It must be a unique value that is not used by other zones and not 1 (which is the default zone). If the DeviceZoneID is not provided, it will be automatically generated by incrementing the value of the last device zone.", "type":"integer" }, "DeviceZoneName":{ "description":"The name for the new device zone.", "type":"string", "example":"Default First Zone" } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new device zone.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceZonesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Zones-post", "x-filename-id":"api-device-zones-post" } }, "/api/device/Zones/readForSelect":{ "get":{ "tags":[ "Device Catalog/Device Zones" ], "summary":"Get Device Zones for Combo Boxes and Item Selectors", "description":"Gets device zones in a format suitable for combo boxes and item selectors.", "operationId":"device::Zones::readForSelect", "parameters":[ { "name":"id", "in":"query", "description":"Either the DeviceZoneID (integer) or the DeviceZoneName (string) of the device zone to get. Returns only results that match the specified ID exactly.", "required":false, "schema":{ "oneOf":[ { "type":"integer" }, { "type":"string" } ] } }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "name":"query", "in":"query", "description":"The DeviceZoneName of the device zone to get. Returns results that are similar to the specified name.", "required":false, "schema":{ "type":"string" } }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of device zones.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceZonesReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-device-Zones-readForSelect-get", "x-filename-id":"api-device-zones-readforselect-get" } }, "/api/deviceNavigation/Devices/readForTree":{ "get":{ "tags":[ "Device Catalog/Device Navigation" ], "summary":"Get Device Groups and Devices in Tree Representation", "description":"Gets the list of device groups and devices in a format suitable for tree grids.", "operationId":"deviceNavigation::Devices::readForTree", "parameters":[ { "name":"node", "in":"query", "description":"The tree node to use. Use root to return all device groups and devices at the root level. Use the node ID for a device group to return child device groups and devices containing the device group.", "schema":{ "type":"string" }, "example":"root" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message.", "type":"string", "example":"Loaded children" }, "data":{ "description":"The list of device groups and devices in tree representation.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceNavigationDevicesRead" } } } } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-deviceNavigation-Devices-readForTree-get", "x-filename-id":"api-devicenavigation-devices-readfortree-get" } }, "/api/deviceNavigation/Devices/readDeviceVertex":{ "get":{ "tags":[ "Device Catalog/Device Navigation" ], "summary":"Get Device Vertex in Graph Database", "description":"Gets the device vertex in the graph database that matches the device name and device zone name.", "operationId":"deviceNavigation::Devices::readDeviceVertex", "parameters":[ { "name":"DeviceName", "in":"query", "description":"The device name, including the zone ID (serialized device name). Oracle recommends including the zone ID with the device name. If you do not, you must include it in the DeviceZoneID parameter.", "required":true, "schema":{ "type":"string" }, "example":"router.example.com;z1 OR router.example.com" }, { "name":"DeviceZoneID", "in":"query", "description":"The ID of the device zone to get performance data for. Deprecated. Use serialized device name instead.", "required":false, "schema":{ "type":"integer" }, "example":1 } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message.", "type":"string", "example":"" }, "data":{ "description":"The required device vertex in the graph database.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceNavigationDevicesReadDeviceVertex" } } } } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-deviceNavigation-Devices-readDeviceVertex-get", "x-filename-id":"api-devicenavigation-devices-readdevicevertex-get" } }, "/api/deviceNavigation/Devices/readForSelect":{ "get":{ "tags":[ "Device Catalog/Device Navigation" ], "summary":"Get Devices for Combo Boxes and Item Selectors", "description":"Gets devices in format suitable for combo boxes and item selectors.", "operationId":"deviceNavigation::Devices::readForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/query" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":1 }, "data":{ "description":"The list of devices.", "type":"array", "items":{ "$ref":"#/components/schemas/deviceNavigationDevicesReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-deviceNavigation-Devices-readForSelect-get", "x-filename-id":"api-devicenavigation-devices-readforselect-get" } }, "/api/deviceNavigation/Devices/readStates":{ "get":{ "tags":[ "Device Catalog/Device Navigation" ], "summary":"Get Availability, Event, and Metric Threshold States of Devices", "description":"This method is deprecated. Use /api/deviceNavigation/Devices/readStatesAvailability, /api/deviceNavigation/Devices/readStatesEvent, and /api/deviceNavigation/Devices/readStatesThresholds.", "operationId":"deviceNavigation::Devices::readStates", "deprecated":true, "parameters":[ { "name":"DeviceID", "in":"query", "description":"The comma-separated list of device IDs.", "required":true, "schema":{ "type":"string" }, "example":"40,10,109,7" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message.", "type":"string", "example":"" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/deviceNavigationDevicesReadStates" } } } } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-deviceNavigation-Devices-readStates-get", "x-filename-id":"api-devicenavigation-devices-readstates-get" } }, "/api/deviceNavigation/Devices/readStatesNetworks":{ "get":{ "tags":[ "Device Catalog/Device Navigation" ], "summary":"Get Network Inventory Status of Devices", "description":"Gets the network inventory status of the devices specified in DeviceID.", "operationId":"deviceNavigation::Devices::readStatesNetworks", "parameters":[ { "name":"DeviceID", "in":"query", "description":"The comma-separated list of device IDs.", "required":true, "schema":{ "type":"string" }, "example":"40,10,109,7" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message.", "type":"string", "example":"Retrieved Network States" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/deviceNavigationDevicesReadStatesNetworks" }, "example":[ { "DeviceID":"109", "NetworkDetails":"nodata", "NetworkDetailsData":[ [ "Unknown" ] ], "LoadingStates":false }, { "DeviceID":"7", "NetworkDetails":"data", "NetworkDetailsData":[ [ "Server: Net-SNMP Linux", 2 ], [ "Interfaces", 8 ], [ "IP Routes", 3 ], [ "ARP Records", 72 ], [ "MAC Addresses", 0 ], [ "VLANs", 0 ], [ "CDP Neighbors", 0 ] ], "LoadingStates":false } ] } } } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-deviceNavigation-Devices-readStatesNetworks-get", "x-filename-id":"api-devicenavigation-devices-readstatesnetworks-get" } }, "/api/deviceNavigation/Devices/readStatesAvailability":{ "get":{ "tags":[ "Device Catalog/Device Navigation" ], "summary":"Get Device Availability Details", "description":"Get availability details about the devices specified in DeviceID to indicate if they have been up or down recently.", "operationId":"deviceNavigation::Devices::readStatesAvailability", "parameters":[ { "name":"DeviceID", "in":"query", "description":"The comma-separated list of device IDs.", "required":true, "schema":{ "type":"string" }, "example":"40,10,109,7" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message.", "type":"string", "example":"Retrieved Availability States" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/deviceNavigationDevicesReadStatesAvailability" }, "example":[ { "DeviceID":"40", "AvailabilityExists":true, "AvailabilitySeverity":"unknown", "Availability":null, "LoadingStates":false }, { "DeviceID":"10", "AvailabilityExists":true, "AvailabilitySeverity":"unknown", "Availability":null, "LoadingStates":false }, { "DeviceID":"109", "AvailabilityExists":true, "AvailabilitySeverity":"normal", "Availability":"100.00", "LoadingStates":false }, { "DeviceID":"7", "AvailabilityExists":true, "AvailabilitySeverity":"normal", "Availability":"100.00", "LoadingStates":false } ] } } } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-deviceNavigation-Devices-readStatesAvailability-get", "x-filename-id":"api-devicenavigation-devices-readstatesavailability-get" } }, "/api/deviceNavigation/Devices/readStatesEvent":{ "get":{ "tags":[ "Device Catalog/Device Navigation" ], "summary":"Get Device Event Details", "description":"Get event details about the devices specified in DeviceID, including the number of events by severity.", "operationId":"deviceNavigation::Devices::readStatesEvent", "parameters":[ { "name":"DeviceID", "in":"query", "description":"The comma-separated list of device IDs.", "required":true, "schema":{ "type":"string" }, "example":"109,7" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message.", "type":"string", "example":"Retrieved Event States" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/deviceNavigationDevicesReadStatesEvent" }, "example":[ { "DeviceID":"109", "EventExists":true, "EventSeverity":"normal", "Count":0, "SumCount":0, "SeverityValues":[ 0, 0, 0, 0, 0, 0 ], "LoadingStates":false }, { "DeviceID":"7", "EventExists":true, "EventSeverity":"major", "Count":32, "SumCount":8627, "SeverityValues":[ 1, 0, 0, 28, 3, 0 ], "LoadingStates":false } ] } } } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-deviceNavigation-Devices-readStatesEvent-get", "x-filename-id":"api-devicenavigation-devices-readstatesevent-get" } }, "/api/deviceNavigation/Devices/readStatesThresholds":{ "get":{ "tags":[ "Device Catalog/Device Navigation" ], "summary":"Get Device Threshold Details", "description":"Get threshold details about the devices specified in DeviceID, including the number of thresholds and breached thresholds.", "operationId":"deviceNavigation::Devices::readStatesThresholds", "parameters":[ { "name":"DeviceID", "in":"query", "description":"The comma-separated list of device IDs.", "required":true, "schema":{ "type":"string" }, "example":"109,7" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message.", "type":"string", "example":"Retrieved Threshold States" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/deviceNavigationDevicesReadStatesThresholds" }, "example":[ { "DeviceID":"109", "ThresholdExists":0, "ThresholdSeverity":"normal", "ThresholdData":[ [ "Metric Thresholds", "Normal", 2 ], [ "Count", 0, 2 ], [ "Critical", 0 ], [ "Warning", 0 ], [ "Normal", 0, 2 ] ], "LoadingStates":false }, { "DeviceID":"7", "ThresholdExists":7, "ThresholdSeverity":"critical", "ThresholdData":[ [ "Metric Thresholds", "Critical", 2 ], [ "Count", 7, 2 ], [ "Critical", 4 ], [ "Warning", 2 ], [ "Normal", 1, 2 ] ], "LoadingStates":false } ] } } } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-deviceNavigation-Devices-readStatesThresholds-get", "x-filename-id":"api-devicenavigation-devices-readstatesthresholds-get" } }, "/api/diagram/Diagrams/{id}":{ "get":{ "tags":[ "Diagrams/Diagrams" ], "summary":"Get a Diagram by ID", "description":"Gets the diagram that matches the specified ID or name.", "operationId":"diagram::Diagrams::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The ID (integer) or name (string) of the diagram to get.", "required":true, "schema":{ "type":"integer", "example":4 } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/diagramDiagramsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-Diagrams-{id}-get", "x-filename-id":"api-diagram-diagrams-id-get" }, "put":{ "tags":[ "Diagrams/Diagrams" ], "summary":"Update a Diagram", "description":"Updates the properties of the diagram that matches the specified ID or name.", "operationId":"diagram::Diagrams::update", "parameters":[ { "name":"id", "in":"path", "description":"The ID (integer) or name (string) of the diagram to update.", "required":true, "schema":{ "type":"integer", "example":4 } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/diagramDiagrams" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the updated diagram.", "type":"array", "items":{ "$ref":"#/components/schemas/diagramDiagramsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-Diagrams-{id}-put", "x-filename-id":"api-diagram-diagrams-id-put" }, "delete":{ "tags":[ "Diagrams/Diagrams" ], "summary":"Delete a Diagram", "description":"Deletes the diagram that matches the specified name. This endpoint does not accept the numerical ID, only the name.", "operationId":"diagram::Diagrams::delete", "parameters":[ { "name":"id", "in":"path", "description":"The name of the diagram to be deleted.", "required":true, "schema":{ "type":"string" }, "example":"ServiceGaugeDiagram" } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-Diagrams-{id}-delete", "x-filename-id":"api-diagram-diagrams-id-delete" } }, "/api/diagram/Diagrams":{ "get":{ "tags":[ "Diagrams/Diagrams" ], "summary":"Get Diagrams", "description":"Gets the diagrams that match the specified parameters. If no parameters are specified, all diagrams are returned.", "operationId":"diagram::Diagrams::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging", "type":"integer", "example":"1" }, "data":{ "description":"The list of diagrams that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/diagramDiagramsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-Diagrams-get", "x-filename-id":"api-diagram-diagrams-get" }, "post":{ "tags":[ "Diagrams/Diagrams" ], "summary":"Create a Diagram", "description":"Creates a new diagram.
The minimum required properties in the request body are:\n ", "operationId":"diagram::Diagrams::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/diagramDiagrams", "required":[ "DiagramName", "DiagramTypeID", "Width", "Height", "DiagramGroupID", "SVG" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new diagram.", "type":"array", "items":{ "$ref":"#/components/schemas/diagramDiagramsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-Diagrams-post", "x-filename-id":"api-diagram-diagrams-post" } }, "/api/diagram/Diagrams/readForSelect":{ "get":{ "tags":[ "Diagrams/Diagrams" ], "summary":"Get Diagrams for Combo Boxes and Item Selectors", "description":"Gets diagrams in a format suitable for combo boxes and item selectors.", "operationId":"diagram::Diagrams::readForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/query" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of diagrams.", "type":"array", "items":{ "$ref":"#/components/schemas/diagramDiagramsReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-Diagrams-readForSelect-get", "x-filename-id":"api-diagram-diagrams-readforselect-get" } }, "/api/diagram/Diagrams/readRevisionForSelect":{ "get":{ "tags":[ "Diagrams/Diagrams" ], "summary":"Get Diagram Revisions for Combo Boxes and Item Selectors", "description":"Gets diagram revisions in a format suitable for combo boxes and item selectors.", "operationId":"diagram::Diagrams::readRevisionForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/query" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of diagram revisions.", "type":"array", "items":{ "$ref":"#/components/schemas/diagramDiagramsReadRevisionsForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-Diagrams-readRevisionForSelect-get", "x-filename-id":"api-diagram-diagrams-readrevisionforselect-get" } }, "/api/diagram/Diagrams/readSVG":{ "get":{ "tags":[ "Diagrams/Diagrams" ], "summary":"Get a Diagram's SVG", "description":"Gets the SVG content for a diagram.", "operationId":"diagram::Diagrams::readSVG", "parameters":[ { "name":"DiagramName", "in":"query", "description":"The diagram name.", "required":true, "schema":{ "type":"string", "example":"Test Diagram" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "image/svg+xml":{ "schema":{ "type":"string" } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-Diagrams-readSVG-get", "x-filename-id":"api-diagram-diagrams-readsvg-get" } }, "/api/diagram/Diagrams/readNewSVG":{ "get":{ "tags":[ "Diagrams/Diagrams" ], "summary":"Get an SVG Template for a New Diagram", "description":"Gets the SVG template that you can use as the base for a new diagram.", "operationId":"diagram::Diagrams::readNewSVG", "responses":{ "200":{ "description":"Successful operation", "content":{ "image/svg+xml":{ "schema":{ "type":"string" } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-Diagrams-readNewSVG-get", "x-filename-id":"api-diagram-diagrams-readnewsvg-get" } }, "/api/diagram/Diagrams/updateRevision":{ "post":{ "tags":[ "Diagrams/Diagrams" ], "summary":"Revert a Diagram to a Specified Revision", "description":"Reverts a diagram to a specified revision.", "operationId":"diagram::Diagrams::updateRevision", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "id", "Revision" ], "properties":{ "id":{ "description":"The diagram ID that has to be reverted.", "type":"integer", "example":5, "required":true }, "Revision":{ "description":"The revision number to which the diagram has to be reverted.", "type":"integer", "example":4, "required":true }, "Message":{ "description":"The message associated with the change (optional).", "type":"string", "example":"Some changes made" } } } } } }, "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulUpdateResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-Diagrams-updateRevision-post", "x-filename-id":"api-diagram-diagrams-updaterevision-post" } }, "/api/diagram/Diagrams/executeDownload":{ "get":{ "tags":[ "Diagrams/Diagrams" ], "summary":"Get Diagram SVG File", "description":"Gets the diagram SVG file that matches the ID or name.", "operationId":"diagram::Diagrams::executeDownload", "parameters":[ { "name":"id", "in":"query", "description":"The ID (integer) or name (string) of the diagram to get.", "required":true, "schema":{ "type":"integer", "example":2 } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "image/svg+xml":{ "schema":{ "type":"string" } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-Diagrams-executeDownload-get", "x-filename-id":"api-diagram-diagrams-executedownload-get" } }, "/api/diagram/Diagrams/readBack":{ "post":{ "tags":[ "Diagrams/Diagrams" ], "summary":"Get the Uploaded SVG Content", "description":"Gets the SVG content that has been uploaded. This is used by the UI to validate the uploaded SVG file containing specific Unified Assurance diagram properties.", "operationId":"diagram::Diagrams::readBack", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "svg":{ "description":"The SVG content.", "type":"object" } } } } } }, "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulGetResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-Diagrams-readBack-post", "x-filename-id":"api-diagram-diagrams-readback-post" } }, "/api/diagram/DiagramGroups/{id}":{ "get":{ "tags":[ "Diagrams/Diagram Groups" ], "summary":"Get a Diagram Group by ID", "description":"Gets the diagram group that matches the specified ID.", "operationId":"diagram::DiagramGroups::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The diagram group ID specified for individual CRUD operations.", "required":true, "schema":{ "type":"integer", "example":3 } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/diagramDiagramGroupReadByID" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-DiagramGroups-{id}-get", "x-filename-id":"api-diagram-diagramgroups-id-get" }, "put":{ "tags":[ "Diagrams/Diagram Groups" ], "summary":"Update a Diagram Group", "description":"Updates the properties of the diagram group that matches the specified ID.", "operationId":"diagram::DiagramGroups::update", "parameters":[ { "name":"id", "in":"path", "description":"The diagram group ID specified for individual CRUD operations.", "required":true, "schema":{ "type":"integer", "example":3 } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/diagramDiagramGroupsUpdate" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"Properties of the updated diagram group.", "type":"array", "items":{ "$ref":"#/components/schemas/diagramDiagramGroupReadByID" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-DiagramGroups-{id}-put", "x-filename-id":"api-diagram-diagramgroups-id-put" }, "delete":{ "tags":[ "Diagrams/Diagram Groups" ], "summary":"Delete a Diagram Group", "description":"Deletes the diagram group that matches the specified ID.", "operationId":"diagram::DiagramGroups::delete", "parameters":[ { "name":"id", "in":"path", "description":"The diagram group ID specified for individual CRUD operations.", "required":true, "schema":{ "type":"integer", "example":3 } } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-DiagramGroups-{id}-delete", "x-filename-id":"api-diagram-diagramgroups-id-delete" } }, "/api/diagram/DiagramGroups":{ "get":{ "tags":[ "Diagrams/Diagram Groups" ], "summary":"Get Diagram Groups", "description":"Gets the diagram groups that match the specified parameters.", "operationId":"diagram::DiagramGroups::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of diagram groups.", "type":"array", "items":{ "$ref":"#/components/schemas/diagramDiagramGroupsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-DiagramGroups-get", "x-filename-id":"api-diagram-diagramgroups-get" }, "post":{ "tags":[ "Diagrams/Diagram Groups" ], "summary":"Create a Diagram Group", "description":"Creates a diagram group.
The minimum required properties in the request body are:\n ", "operationId":"diagram::DiagramGroups::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/diagramDiagramGroups", "required":[ "DiagramGroupName", "Diagrams" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new diagram group.", "type":"array", "items":{ "$ref":"#/components/schemas/diagramDiagramGroupReadByID" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-DiagramGroups-post", "x-filename-id":"api-diagram-diagramgroups-post" } }, "/api/diagram/DiagramGroups/readForTree":{ "get":{ "tags":[ "Diagrams/Diagram Groups" ], "summary":"Get Diagram Groups for Tree Grids", "description":"Gets diagram groups in a format suitable for tree grids.", "operationId":"diagram::DiagramGroups::readForTree", "parameters":[ { "name":"node", "in":"query", "description":"The node of the tree to get. You can specify root, the numerical ID, or the full tree path.", "required":true, "schema":{ "type":"string" }, "example":"root" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of diagram groups.", "type":"array", "items":{ "$ref":"#/components/schemas/diagramDiagramGroupsReadForTree" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-DiagramGroups-readForTree-get", "x-filename-id":"api-diagram-diagramgroups-readfortree-get" } }, "/api/diagram/DiagramGroups/readForTreeCombo":{ "get":{ "tags":[ "Diagrams/Diagram Groups" ], "summary":"Get Diagram Groups for Tree Combos", "description":"Gets diagram groups in a format suitable for tree combos.", "operationId":"diagram::DiagramGroups::readForTreeCombo", "parameters":[ { "name":"node", "in":"query", "description":"The node of the tree to get. You can specify root, the numerical ID, or the full tree path.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of device groups.", "type":"array", "items":{ "$ref":"#/components/schemas/diagramDiagramGroupsReadForTree" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-DiagramGroups-readForTreeCombo-get", "x-filename-id":"api-diagram-diagramgroups-readfortreecombo-get" } }, "/api/diagram/DiagramGroups/updateDiagrams":{ "put":{ "tags":[ "Diagrams/Diagram Groups" ], "summary":"Move or Copy Diagrams to a Different Group", "description":"Moves or copies diagrams to a different group. To move, specify a source group in SourceDiagramGroupID. To copy, do not specify a source group.", "operationId":"diagram::DiagramGroups::updateDiagrams", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "id":{ "description":"The ID of the destination diagram group.", "type":"integer", "example":3 }, "SourceDiagramGroupID":{ "description":"The ID of the source diagram group. To move diagrams,specify an ID. To copy diagrams, do not use this parameter.", "type":"integer" }, "Diagrams":{ "description":"The list of diagram IDs to move or copy.", "type":"array", "items":{ "type":"integer" }, "example":[ 1, 2, 3 ] } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The destination diagram group with the moved or copied diagrams.", "type":"array", "items":{ "$ref":"#/components/schemas/diagramDiagramGroupReadByID" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-DiagramGroups-updateDiagrams-put", "x-filename-id":"api-diagram-diagramgroups-updatediagrams-put" } }, "/api/diagram/DiagramGroups/updateMove":{ "put":{ "tags":[ "Diagrams/Diagram Groups" ], "summary":"Move Diagram Groups to a Different Parent", "description":"Moves the diagram groups listed in id to the parent specified in ParentDiagramGroupID.", "operationId":"diagram::DiagramGroups::updateMove", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "id":{ "description":"The comma-separated list of diagram group IDs.", "type":"integer", "example":2 }, "ParentDiagramGroupID":{ "description":"The diagram group ID of the new parent.", "type":"integer", "example":"1" } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "success":{ "description":"Whether the operation was a success (true) or failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message in text.", "type":"string", "example":"Updated record(s)" }, "data":{ "description":"The properties of the parent diagram group.", "type":"array", "items":{ "$ref":"#/components/schemas/diagramDiagramGroupReadByID" } } } } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-DiagramGroups-updateMove-put", "x-filename-id":"api-diagram-diagramgroups-updatemove-put" } }, "/api/diagram/Menus/{id}":{ "get":{ "tags":[ "Diagrams/Diagram Menus" ], "summary":"Get a Diagram Menu by ID", "description":"Gets the diagram menu that matches the specified ID.", "operationId":"diagram::Menus::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The diagram menu ID specified for individual CRUD operations.", "required":true, "schema":{ "type":"integer" }, "example":2 }, { "name":"readChildren", "in":"query", "description":"Allowed values\n- true -> Returns only children menu group information (for tree display).\n- false -> Returns children menus and menu tools details associated with the diagram menu (for form display).", "required":false, "schema":{ "type":"boolean" }, "example":false } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/diagramMenusReadByID" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-Menus-{id}-get", "x-filename-id":"api-diagram-menus-id-get" }, "put":{ "tags":[ "Diagrams/Diagram Menus" ], "summary":"Update a Diagram Menu", "description":"Updates the diagram menu that matches the specified ID.", "operationId":"diagram::Menus::update", "parameters":[ { "name":"id", "in":"path", "description":"The diagram menu ID specified for individual CRUD operations.", "required":true, "schema":{ "type":"integer", "example":2 } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/diagramMenuUpdate" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the updated diagram menu.", "type":"array", "items":{ "type":"integer" }, "example":[ 2, 1, 3 ] } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-Menus-{id}-put", "x-filename-id":"api-diagram-menus-id-put" }, "delete":{ "tags":[ "Diagrams/Diagram Menus" ], "summary":"Delete a Diagram Menu", "description":"Deletes a diagram menu that matches the specified ID.", "operationId":"diagram::Menus::delete", "parameters":[ { "name":"id", "in":"path", "description":"The diagram menu ID specified for individual CRUD operations.", "required":true, "schema":{ "type":"integer", "example":2 } } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-Menus-{id}-delete", "x-filename-id":"api-diagram-menus-id-delete" } }, "/api/diagram/Menus":{ "get":{ "tags":[ "Diagrams/Diagram Menus" ], "summary":"Get Diagram Menus", "description":"Gets the diagram menus that match the specified parameters. If no parameters are specified, all diagram menus are returned.", "operationId":"diagram::Menus::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of diagram menus that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/diagramMenusRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-Menus-get", "x-filename-id":"api-diagram-menus-get" }, "post":{ "tags":[ "Diagrams/Diagram Menus" ], "summary":"Create a Diagram Menu", "description":"Creates a new diagram menu.
The minimum required properties in the request body are:\n ", "operationId":"diagram::Menus::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/diagramMenu", "required":[ "MenuName", "ParentMenuID", "Tools" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new diagram menu.", "type":"object", "example":{ "id":6 } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-Menus-post", "x-filename-id":"api-diagram-menus-post" } }, "/api/diagram/Menus/readForSelect":{ "get":{ "tags":[ "Diagrams/Diagram Menus" ], "summary":"Get Menus for Combo Boxes and Item Selectors", "description":"Gets menus in a format suitable for combo boxes and item selectors.", "operationId":"diagram::Menus::readForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/query" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging", "type":"integer", "example":"1" }, "data":{ "description":"The list of diagram menus.", "type":"array", "items":{ "$ref":"#/components/schemas/diagramMenusReadForSelect" }, "example":[ { "MenuID":"2", "MenuName":"Device Info" }, { "MenuID":"1", "MenuName":"Root" } ] } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-Menus-readForSelect-get", "x-filename-id":"api-diagram-menus-readforselect-get" } }, "/api/diagram/Menus/readForMenu":{ "get":{ "tags":[ "Diagrams/Diagram Menus" ], "summary":"Get Menus for Diagram Menu", "description":"Returns the constructed list of menus and associated menu tools of a diagram menu.", "operationId":"diagram::Menus::readForMenu", "parameters":[ { "name":"node", "in":"query", "description":"The node of the tree to get. It can be either root or DiagramMenuID.", "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of menus.", "type":"array", "items":{ "$ref":"#/components/schemas/diagramMenusReadForMenu" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-Menus-readForMenu-get", "x-filename-id":"api-diagram-menus-readformenu-get" } }, "/api/diagram/Menus/updateMove":{ "put":{ "tags":[ "Diagrams/Diagram Menus" ], "summary":"Move a Diagram Menu to a Different Parent", "description":"Moves the specified diagram menu from one parent to a different parent.", "operationId":"diagram::Menus::updateMove", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "id":{ "description":"The ID of the menu to move.", "type":"integer", "example":4 }, "ParentMenuID":{ "description":"The ID of the new parent menu.", "type":"integer", "example":1 } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new parent.", "type":"array", "items":{ "$ref":"#/components/schemas/diagramMenusReadByID" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-Menus-updateMove-put", "x-filename-id":"api-diagram-menus-updatemove-put" } }, "/api/diagram/Menus/updateTools":{ "put":{ "tags":[ "Diagrams/Diagram Menus" ], "summary":"Move or Copy Diagram Tools to a New Menu", "description":"Moves or copies diagram tools to a new menu. To move, specify a source menu in SourceMenuID. To copy, do not specify a source menu.", "operationId":"diagram::Menus::updateTools", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "id":{ "description":"The ID of the destination menu.", "type":"integer", "example":4 }, "SourceMenuID":{ "description":"The ID of the source menu. To move tools, specify an ID. To copy tools, do not use this parameter.", "type":"integer" }, "Tools":{ "description":"The list of tool IDs to move or copy.", "type":"array", "items":{ "type":"integer" }, "example":[ 1, 2, 3 ] } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The destination diagram menu with the moved or copied menu tools.", "type":"array", "items":{ "$ref":"#/components/schemas/diagramMenusReadByID" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-Menus-updateTools-put", "x-filename-id":"api-diagram-menus-updatetools-put" } }, "/api/diagram/Tools/{id}":{ "get":{ "tags":[ "Diagrams/Diagram Tools" ], "summary":"Get a Diagram Tool by ID", "description":"Gets the diagram tool that matches the specified ID.", "operationId":"diagram::Tools::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The diagram tool ID specified for individual CRUD operations.", "required":true, "schema":{ "type":"integer", "example":2 } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/diagramToolsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-Tools-{id}-get", "x-filename-id":"api-diagram-tools-id-get" }, "put":{ "tags":[ "Diagrams/Diagram Tools" ], "summary":"Update a Diagram Tool", "description":"Updates the properties of the diagram tool.", "operationId":"diagram::Tools::update", "parameters":[ { "name":"id", "in":"path", "description":"The diagram tool ID specified for individual CRUD operations.", "required":true, "schema":{ "type":"integer", "example":2 } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/diagramTools" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the updated diagram tool.", "type":"array", "items":{ "$ref":"#/components/schemas/diagramToolsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-Tools-{id}-put", "x-filename-id":"api-diagram-tools-id-put" }, "delete":{ "tags":[ "Diagrams/Diagram Tools" ], "summary":"Delete a Diagram Tool", "description":"Deletes the diagram tool that matches the specified ID.", "operationId":"diagram::Tools::delete", "parameters":[ { "name":"id", "in":"path", "description":"The diagram tool ID specified for individual CRUD operations.", "required":true, "schema":{ "type":"integer", "example":2 } } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-Tools-{id}-delete", "x-filename-id":"api-diagram-tools-id-delete" } }, "/api/diagram/Tools":{ "get":{ "tags":[ "Diagrams/Diagram Tools" ], "summary":"Get Diagram Tools", "description":"Gets the diagram tools that match the specified parameters. If no parameters are specified, all diagram tools are returned.", "operationId":"diagram::Tools::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of diagram tools that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/diagramToolsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-Tools-get", "x-filename-id":"api-diagram-tools-get" }, "post":{ "tags":[ "Diagrams/Diagram Tools" ], "summary":"Create a Diagram Tool", "description":"Creates a diagram tool.
The minimum required properties in the request body are:\n ", "operationId":"diagram::Tools::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/diagramTools", "required":[ "ToolName", "Icon" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new diagram tool.", "type":"array", "items":{ "$ref":"#/components/schemas/diagramToolsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-Tools-post", "x-filename-id":"api-diagram-tools-post" } }, "/api/diagram/Tools/readForSelect":{ "get":{ "tags":[ "Diagrams/Diagram Tools" ], "summary":"Get Diagram Tools for Combo Boxes and Item Selectors", "description":"Gets diagram tools in a format suitable for combo boxes and item selectors.", "operationId":"diagram::Tools::readForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/query" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of diagram tools.", "type":"array", "items":{ "$ref":"#/components/schemas/diagramToolsReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-Tools-readForSelect-get", "x-filename-id":"api-diagram-tools-readforselect-get" } }, "/api/diagram/Tools/executeViewTool/{id}":{ "get":{ "tags":[ "Diagrams/Diagram Tools" ], "summary":"Run a View Tool", "description":"Runs a view tool when a user selects a context menu from a diagram widget in the UI.", "operationId":"diagram::Tools::executeViewTool", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the selected diagram tool.", "required":true, "schema":{ "type":"integer", "example":6 } }, { "name":"WidgetProps", "in":"query", "required":true, "description":"Properties of the selected diagram widget.", "schema":{ "type":"object", "example":{ "id":"Widget_1-451", "transform":"translate(196, 111) rotate(0, 32, 32)", "WidgetType":"BasicEllipse", "LinkType":"None", "LinkTarget":"", "LinkValue":"", "LinkExtra":"", "MenuID":"5", "cursor":"" } } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/diagramToolsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-Tools-executeViewTool-{id}-get", "x-filename-id":"api-diagram-tools-executeviewtool-id-get" } }, "/api/diagram/Types/readForSelect":{ "get":{ "tags":[ "Diagrams/Diagram Types" ], "summary":"Get Diagram Types for Combo Boxes and Item Selectors", "description":"Gets diagram types in a format suitable for combo boxes and item selectors.", "operationId":"diagram::Types::readForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/query" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of diagram types.", "type":"array", "items":{ "$ref":"#/components/schemas/diagramTypesReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-Types-readForSelect-get", "x-filename-id":"api-diagram-types-readforselect-get" } }, "/api/diagram/Widgets":{ "get":{ "tags":[ "Diagrams/Widgets" ], "summary":"Get Widgets", "description":"Gets the supported widgets that match the specified parameters. If no parameters are specified, all widgets are returned.", "operationId":"diagram::Widgets::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of widgets that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/diagramWidgetsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-Widgets-get", "x-filename-id":"api-diagram-widgets-get" } }, "/api/diagram/Widgets/readEventStatus":{ "post":{ "tags":[ "Diagrams/Widgets" ], "summary":"Get Event Widget Status", "description":"Gets the event severity status for the list of diagram widgets. For each widget listed in the request body, this API makes a GET request to the /api/event/Events endpoint to get the status.", "operationId":"diagram::Widgets::readEventStatus", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "WidgetType":{ "description":"Type of Widget", "type":"string", "example":"EventEllipse" }, "Widgets":{ "description":"List of event widgets with event parameters.", "type":"array", "items":{ "type":"object", "properties":{ "WidgetID":{ "description":"The unique widget ID within the diagram.", "type":"integer", "example":"Widget_1-497" }, "FilterType":{ "description":"The filter type.", "type":"string", "example":"FilterID" }, "DeviceName":{ "description":"The name of an associated device name, if any.", "type":"string", "nullable":true, "example":"Device1" }, "DisplayName":{ "description":"The display name.", "type":"string", "example":"Default" }, "FilterGroupName":{ "description":"The filter group name.", "type":"string", "example":"//Global" }, "FilterValueName":{ "description":"The filter value name.", "type":"string", "example":"All Events" }, "DeviceZoneName":{ "description":"The device zone name, if any.", "type":"string", "nullable":true, "example":"Zone1" }, "DeviceZoneID":{ "description":"The device zone ID, if any.", "type":"integer", "nullable":true, "example":1 }, "AllZonesRecord":{ "description":"The record of all zones, if any.", "type":"string", "nullable":true, "example":"" } } }, "example":[ { "WidgetID":"Widget_1-497", "FilterType":"FilterID", "DeviceName":null, "DisplayName":"Default", "FilterGroupName":"//Global", "FilterValueName":"All Events", "DeviceZoneName":null, "DeviceZoneID":null, "AllZonesRecord":null }, { "WidgetID":"Widget_2-497", "FilterType":"TEL", "DeviceName":null, "DisplayName":"Default", "FilterGroupName":"", "FilterValueName":"Severity=3 AND EventType='Ping Jitter Utilization High' AND Node like 'qa2%'", "DeviceZoneName":null, "DeviceZoneID":null, "AllZonesRecord":null } ] } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The status of the event widget.", "type":"array", "items":{ "type":"object", "properties":{ "WidgetID":{ "description":"The unique widget ID within the diagram.", "type":"integer", "example":"Widget_1-497" }, "SeverityCounts":{ "description":"The array of event severity counts in the order from Normal to Critical.\nThe order of severity in the list is: Normal, Unknown, Info, Minor, Major, Critical.", "type":"array", "items":{ "type":"integer" }, "example":[ 7, 1, 1, 1620, 807, 164 ] }, "Count":{ "description":"The number of unique events (ie Rows).", "type":"integer", "example":2600 }, "SumOfCount":{ "description":"The sum of count is the total count, SUM(Count),of all events. Each event can be deduplicated and the count for each one can be more than 1. Sum includes everything. For example, for a device with 2 events, the first with a count of 1 and the second with a count of 9; the Count is 2, and the SumOfCount is 10.", "type":"integer", "example":122761923 } } }, "example":[ { "WidgetID":"Widget_1-497", "SeverityCounts":[ 7, 1, 1, 1620, 807, 164 ], "Count":2600, "SumOfCount":122761923 }, { "WidgetID":"Widget_2-497", "SeverityCounts":[ 0, 0, 0, 5, 0, 0 ], "Count":5, "SumOfCount":8621 } ] }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-Widgets-readEventStatus-post", "x-filename-id":"api-diagram-widgets-readeventstatus-post" } }, "/api/diagram/Widgets/readMetricStatus":{ "post":{ "tags":[ "Diagrams/Widgets" ], "summary":"Get Metric Widget Status", "description":"Gets the metric status for the list of diagram widgets.", "operationId":"diagram::Widgets::readMetricStatus", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "WidgetType":{ "description":"The type of metric value to get. Specifying MetricGraph calls the /api/metric/PerformanceData endpoint and returns a graph series. Specifying any other value calls the /api/metric/PerformanceData/readSummary endpoint and returns the threshold status.", "type":"string", "example":"MetricGraph" }, "Widgets":{ "description":"The list of metric widgets with metric parameters.", "type":"array", "items":{ "type":"object", "properties":{ "WidgetID":{ "description":"The Widget ID.", "type":"integer", "example":"Widget_1-497" }, "DeviceName":{ "description":"The name of an associated device name, if any.", "type":"string", "example":"device.example.com" }, "DeviceZoneName":{ "description":"Device Zone name, if any.", "type":"string", "nullable":true, "example":"Device1" }, "DeviceZoneID":{ "description":"Device zone ID, if any.", "type":"integer", "nullable":true, "example":1 }, "MetricTypeName":{ "description":"Name of the metric type.", "type":"string", "example":"CPU Utilization" }, "InstanceName":{ "description":"Name of the instance.", "type":"string", "example":"Device" }, "TimeRange":{ "description":"The time Range.", "type":"string", "example":"now-24h..now" }, "ThresholdTypeID":{ "description":"The threshold Type ID.", "type":"integer", "example":"1" }, "MetricField":{ "description":"The string of the metric that is collected.", "type":"string", "example":"undefined" }, "WarningThresholdName":{ "description":"The warning threshold name.", "type":"string", "example":"" }, "CriticalThresholdName":{ "description":"The Critical threshold name.", "type":"string", "example":"" } } }, "example":[ { "WidgetID":"Widget_1-510", "DeviceName":"device.example.com", "DeviceZoneName":null, "DeviceZoneID":null, "MetricTypeName":"CPU Utilization", "InstanceName":"Device", "TimeRange":"now-24h..now", "ThresholdTypeID":"1", "MetricField":"undefined", "WarningThresholdName":"", "CriticalThresholdName":"" } ] } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The status of the metric widget.", "type":"array", "items":{ "type":"object", "properties":{ "WidgetID":{ "description":"The Widget ID.", "type":"integer", "example":"Widget_1-497" }, "Maximum":{ "description":"Metric Maximum (0 for no max)", "type":"integer", "example":"100" }, "Factor":{ "description":"The factor to change units into raw.", "type":"integer", "example":"1" }, "UnitDivision":{ "description":"The unit division factor.", "type":"integer", "example":"0" }, "Unit":{ "description":"The Value unit.", "type":"string", "example":"Percent Utilization" }, "Abbr":{ "description":"The unit abbreviation.", "type":"string", "example":"%" }, "CriticalThreshold":{ "example":"" }, "WarningThreshold":{ "example":"" }, "MetricInstanceName":{ "description":"The metric display (custom) instance name.", "type":"string", "example":"Device" }, "InstanceName":{ "description":"The metric instance Name corresponding to MetricInstances.InstanceName.", "type":"string", "example":"Device" }, "MetricTypeName":{ "description":"The metric type name corresponding to MetricTypes.MetricTypeName.", "type":"string", "example":"CPU Utilization" }, "Measurement":{ "description":"The measurement or multiple, comma-separated measurements.", "type":"string", "example":"metrictype_CPU_Utilization" }, "PollTime":{ "description":"The metric collection interval (used for display only).", "type":"integer", "example":"300" }, "AverageValue":{ "description":"The average (mean) value.", "type":"integer", "example":28.15972222222222 }, "MinimumValue":{ "description":"The minimum value.", "type":"integer", "example":23 }, "MaximumValue":{ "description":"The maximum value.", "type":"integer", "example":51 }, "SumValue":{ "description":"The sum of value (over polltime). Not valid for all metrics.", "type":"integer", "example":"N/A" }, "LastValue":{ "description":"The last value reported.", "type":"integer", "example":31 }, "AverageAvailability":{ "description":"The average availability.", "type":"integer", "example":1 }, "MinimumAvailability":{ "description":"The minimum availability.", "type":"integer", "example":1 }, "MaximumAvailability":{ "description":"The maximum availability.", "type":"integer", "example":1 }, "LastAvailability":{ "description":"The last availability.", "type":"integer", "example":1 }, "AverageUtilization":{ "description":"The average (mean) utilization.", "type":"integer", "example":28.159722222222232 }, "MinimumUtilization":{ "description":"The minimum utilization.", "type":"integer", "example":23 }, "MaximumUtilization":{ "description":"The maximum utilization.", "type":"integer", "example":51 }, "LastUtilization":{ "description":"The last utilization.", "type":"integer", "example":31 } } } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagram-Widgets-readMetricStatus-post", "x-filename-id":"api-diagram-widgets-readmetricstatus-post" } }, "/api/diagramNavigation/Diagrams/readForTree":{ "get":{ "tags":[ "Diagrams/Diagram Navigation" ], "summary":"Get Diagrams and Groups Under a Specific Node", "description":"Gets the list of diagram groups and diagrams in a format suitable for tree grids.", "operationId":"diagramNavigation::Diagrams::readForTree", "parameters":[ { "name":"node", "in":"query", "description":"The node to the tree. It can be root or DiagramGroupID or full tree path.", "required":true, "schema":{ "type":"string", "example":"root" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of diagram groups and diagrams.", "type":"array", "items":{ "$ref":"#/components/schemas/diagramNavigationReadForTree" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-diagramNavigation-Diagrams-readForTree-get", "x-filename-id":"api-diagramnavigation-diagrams-readfortree-get" } }, "/api/discovery/Discover/readServers":{ "get":{ "tags":[ "Device Discovery/Discovery" ], "summary":"Get Servers Supporting Auto Discovery for Combo Boxes and Item Selectors", "description":"Gets servers supporting auto discovery in a format suitable for combo boxes and item selectors.", "operationId":"discovery::Discover::readServers", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of servers supporting auto discovery.", "type":"array", "items":{ "type":"object", "properties":{ "ServerID":{ "description":"The server ID.", "type":"integer", "example":1 }, "ServerName":{ "description":"The server name.", "type":"string", "example":"server.example.com" } } } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-discovery-Discover-readServers-get", "x-filename-id":"api-discovery-discover-readservers-get" } }, "/api/discovery/Discover/executeRun":{ "get":{ "tags":[ "Device Discovery/Discovery" ], "summary":"Start an Auto Discovery or SNMP Discovery Job", "description":"Starts an auto discovery or SNMP discovery job on the server that matches the specified ID.", "operationId":"discovery::Discover::executeRun", "parameters":[ { "name":"ServerID", "in":"query", "description":"The server ID to remotely execute discovery. If specified, only the array of jobs is returned. If not, only the array of servers is returned.", "required":true, "schema":{ "type":"integer", "example":1 } }, { "name":"JobName", "in":"query", "description":"The job name on the specified server.", "required":false, "schema":{ "type":"string", "example":"Device Auto Discovery" } }, { "name":"JobID", "in":"query", "description":"The job ID on the specified server.", "required":true, "schema":{ "type":"integer", "example":1 } }, { "name":"DeviceHosts", "in":"query", "description":"The comma-separated list of IP Addresses or FQDNs for devices.", "required":true, "schema":{ "type":"string", "example":"100.77.220.52, 100.77.220.19" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "success":{ "description":"Whether the operation was a success (true) or failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message.", "type":"string", "example":"Device Auto Discovery: Process queued to start" } } } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-discovery-Discover-executeRun-get", "x-filename-id":"api-discovery-discover-executerun-get" } }, "/api/discovery/Discover/readDiscoveryJobs":{ "get":{ "tags":[ "Device Discovery/Discovery" ], "summary":"Get Servers with Specified Package and Job Configuration", "description":"Gets the servers that have a specific package installed and a certain job configured.", "operationId":"discovery::Discover::readDiscoveryJobs", "parameters":[ { "name":"Package", "in":"query", "description":"The servers that have the package installed. The default value is coreCollection-app.", "required":false, "schema":{ "type":"string" } }, { "name":"JobProg", "in":"query", "description":"The name of the required job. The default value is DeviceSNMPDiscovery.", "required":false, "schema":{ "type":"string" } }, { "name":"ServerID", "in":"query", "description":"The server ID. If specified, only the array of jobs is returned. If not, only the array of servers is returned.", "required":false, "schema":{ "type":"integer" } }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"The list of servers and jobs. It returns server array when the ServerID is not provided, and job array when the ServerID is provided.", "type":"array", "items":{ "$ref":"#/components/schemas/discoveryDiscoverReadDiscoveryJobs" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-discovery-Discover-readDiscoveryJobs-get", "x-filename-id":"api-discovery-discover-readdiscoveryjobs-get" } }, "/api/discovery/Discover/readDiscoveryJobServers":{ "get":{ "tags":[ "Device Discovery/Discovery" ], "summary":"Get Servers with Specified Package", "description":"Gets the servers with the specified package installed.", "operationId":"discovery::Discover::readDiscoveryJobServers", "parameters":[ { "name":"Package", "in":"query", "description":"Servers that have the package installed. The default value is coreCollection-app.", "required":false, "schema":{ "type":"string" } }, { "name":"JobProg", "in":"query", "description":"Jobs that matches the name. The default value is DeviceSNMPDiscovery.", "required":false, "schema":{ "type":"string" } }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"List of servers.", "type":"array", "items":{ "$ref":"#/components/schemas/discoveryDiscoverReadDiscoveryJobServers" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-discovery-Discover-readDiscoveryJobServers-get", "x-filename-id":"api-discovery-discover-readdiscoveryjobservers-get" } }, "/api/discovery/Discover/readDiscoveryJobJobs":{ "get":{ "tags":[ "Device Discovery/Discovery" ], "summary":"Get Jobs Associated with Specified Server and Job Program", "description":"Gets the list of jobs associated with the chosen server and job program.", "operationId":"discovery::Discover::readDiscoveryJobJobs", "parameters":[ { "name":"Package", "in":"query", "description":"Servers that have the package installed. The default value is coreCollection-app.", "required":false, "schema":{ "type":"string" } }, { "name":"JobProg", "in":"query", "description":"Jobs that matches the name. The default value is DeviceSNMPDiscovery.", "required":false, "schema":{ "type":"string" } }, { "name":"ServerID", "in":"query", "description":"The required server to filter the jobs.", "required":false, "schema":{ "type":"integer" } }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"List of jobs for the specified server.", "type":"array", "items":{ "$ref":"#/components/schemas/discoveryDiscoverReadDiscoveryJobJobs" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-discovery-Discover-readDiscoveryJobJobs-get", "x-filename-id":"api-discovery-discover-readdiscoveryjobjobs-get" } }, "/api/discovery/Excludes/{id}":{ "get":{ "tags":[ "Device Discovery/Exclusion Profiles" ], "summary":"Get an Exclusion Profile by ID", "description":"Gets the exclusion profile that matches the specified ID.", "operationId":"discovery::Excludes::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The discovery profile ID.", "required":true, "schema":{ "type":"integer", "example":1 } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The properties of the specified exclusion profile.", "type":"array", "items":{ "$ref":"#/components/schemas/discoveryExcludesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-discovery-Excludes-{id}-get", "x-filename-id":"api-discovery-excludes-id-get" }, "put":{ "tags":[ "Device Discovery/Exclusion Profiles" ], "summary":"Update an Exclusion Profile", "description":"Updates the properties of the exclusion profile that matches the specified ID.", "operationId":"discovery::Excludes::update", "parameters":[ { "name":"id", "in":"path", "description":"The discovery profile ID.", "required":true, "schema":{ "type":"integer", "example":1 } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/discoveryExcludes" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The properties of the updated exclusion profile.", "type":"array", "items":{ "$ref":"#/components/schemas/discoveryExcludesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-discovery-Excludes-{id}-put", "x-filename-id":"api-discovery-excludes-id-put" }, "delete":{ "tags":[ "Device Discovery/Exclusion Profiles" ], "summary":"Delete an Exclusion Profile", "description":"Deletes the exclusion profile that matches the specified ID.", "operationId":"discovery::Excludes::delete", "parameters":[ { "name":"id", "in":"path", "description":"The discovery profile ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":2 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-discovery-Excludes-{id}-delete", "x-filename-id":"api-discovery-excludes-id-delete" } }, "/api/discovery/Excludes":{ "get":{ "tags":[ "Device Discovery/Exclusion Profiles" ], "summary":"Get Discovery Exclusion Profiles", "description":"Gets the discovery exclusion profiles that match the specified parameters. If no parameters are specified, all discovery exclusion profiles are returned.", "operationId":"discovery::Excludes::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging", "type":"integer", "example":"1" }, "data":{ "description":"The list of discovery exclusion profiles that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/discoveryExcludesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-discovery-Excludes-get", "x-filename-id":"api-discovery-excludes-get" }, "post":{ "tags":[ "Device Discovery/Exclusion Profiles" ], "summary":"Create an Exclusion Profile", "description":"Creates a new exclusion profile.
The minimum required properties in the request body are:\n ", "operationId":"discovery::Excludes::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/discoveryExcludes" } ], "required":[ "ProfileName", "DeviceZoneID", "ProfileStatusID", "ProfileTypeID" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The properties of the new exclusion profile.", "type":"array", "items":{ "$ref":"#/components/schemas/discoveryExcludesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-discovery-Excludes-post", "x-filename-id":"api-discovery-excludes-post" } }, "/api/discovery/Excludes/readForSelect":{ "get":{ "tags":[ "Device Discovery/Exclusion Profiles" ], "summary":"Get Discovery Exclusion Profiles for Combo Boxes and Item Selectors", "description":"Gets discovery exclusion profiles in a format suitable for combo boxes and item selectors.", "operationId":"discovery::Excludes::readForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of discovery exclusion profiles.", "type":"array", "items":{ "$ref":"#/components/schemas/discoveryExcludesReadForSelect" }, "example":[ { "ProfileID":"2", "ProfileName":"Example Device List" }, { "ProfileID":"1", "ProfileName":"Example IP Range" }, { "ProfileID":"3", "ProfileName":"TEST-NET-1" }, { "ProfileID":"4", "ProfileName":"TEST-NET-2" }, { "ProfileID":"5", "ProfileName":"TEST-NET-3" } ] } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-discovery-Excludes-readForSelect-get", "x-filename-id":"api-discovery-excludes-readforselect-get" } }, "/api/discovery/Includes/{id}":{ "get":{ "tags":[ "Device Discovery/Inclusion Profiles" ], "summary":"Get an Inclusion Profile by ID", "description":"Gets the inclusion profile that matches the specified ID.", "operationId":"discovery::Includes::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The discovery profile ID.", "required":true, "schema":{ "type":"integer", "example":1 } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The properties of the specified inclusion profile.", "type":"array", "items":{ "$ref":"#/components/schemas/discoveryIncludesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-discovery-Includes-{id}-get", "x-filename-id":"api-discovery-includes-id-get" }, "put":{ "tags":[ "Device Discovery/Inclusion Profiles" ], "summary":"Update an Inclusion Profile", "description":"Updates the properties of the inclusion profile that matches the specified ID.", "operationId":"discovery::Includes::update", "parameters":[ { "name":"id", "in":"path", "description":"The discovery profile ID.", "required":true, "schema":{ "type":"integer", "example":1 } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/discoveryIncludesUpdate" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The properties of the updated inclusion profile.", "type":"array", "items":{ "$ref":"#/components/schemas/discoveryIncludesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-discovery-Includes-{id}-put", "x-filename-id":"api-discovery-includes-id-put" }, "delete":{ "tags":[ "Device Discovery/Inclusion Profiles" ], "summary":"Delete an Inclusion Profile", "description":"Deletes the inclusion profile that matches the specified ID.", "operationId":"discovery::Includes::delete", "parameters":[ { "name":"id", "in":"path", "description":"The discovery profile ID.", "required":true, "schema":{ "type":"integer", "example":2 } } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-discovery-Includes-{id}-delete", "x-filename-id":"api-discovery-includes-id-delete" } }, "/api/discovery/Includes":{ "get":{ "tags":[ "Device Discovery/Inclusion Profiles" ], "summary":"Get Discovery Inclusion Profiles", "description":"Gets the discovery inclusion profiles that match the specified parameters. If no parameters are specified, all discovery inclusion profiles are returned.", "operationId":"discovery::Includes::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of discovery inclusion profiles that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/discoveryIncludesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-discovery-Includes-get", "x-filename-id":"api-discovery-includes-get" }, "post":{ "tags":[ "Device Discovery/Inclusion Profiles" ], "summary":"Create an Inclusion Profile", "description":"Creates a new inclusion profile. The inclusion profile can be one of four types- Ping, Seed, LDAP or CDP.
The minimum required properties in the request body are:\n ", "operationId":"discovery::Includes::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/discoveryIncludes" } ], "required":[ "ProfileName", "ProfileStatusID", "ProfileTypeID", "DeviceZoneID" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The properties of the new inclusion profile.", "type":"array", "items":{ "$ref":"#/components/schemas/discoveryIncludesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-discovery-Includes-post", "x-filename-id":"api-discovery-includes-post" } }, "/api/discovery/Includes/readForSelect":{ "get":{ "tags":[ "Device Discovery/Inclusion Profiles" ], "summary":"Get Discovery Inclusion Profiles for Combo Boxes and Item Selectors", "description":"Gets discovery inclusion profiles in a format suitable for combo boxes and item selectors.", "operationId":"discovery::Includes::readForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of discovery inclusion profiles.", "type":"array", "items":{ "$ref":"#/components/schemas/discoveryIncludesReadForSelect" }, "example":[ { "ProfileID":"3", "ProfileName":"Example Active Directory Scan" }, { "ProfileID":"4", "ProfileName":"Example CDP Scan" }, { "ProfileID":"1", "ProfileName":"Example Ping Scan" }, { "ProfileID":"2", "ProfileName":"Example Seed Scan" } ] } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-discovery-Includes-readForSelect-get", "x-filename-id":"api-discovery-includes-readforselect-get" } }, "/api/discovery/Snmp/{id}":{ "get":{ "tags":[ "Device Discovery/SNMP Access" ], "summary":"Get an SNMP Access Profile by ID", "description":"Gets the SNMP access profile that matches the specified ID.", "operationId":"discovery::SNMP::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The discovery SNMP access profile ID.", "required":true, "schema":{ "type":"integer", "example":1 } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The properties of the specified SNMP access profile.", "type":"array", "items":{ "$ref":"#/components/schemas/discoverySNMPRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-discovery-Snmp-{id}-get", "x-filename-id":"api-discovery-snmp-id-get" }, "put":{ "tags":[ "Device Discovery/SNMP Access" ], "summary":"Update an SNMP Access Profile", "description":"Updates the properties of the SNMP access profile that matches the specified ID.", "operationId":"discovery::SNMP::update", "parameters":[ { "name":"id", "in":"path", "description":"The discovery SNMP access profile ID.", "required":true, "schema":{ "type":"integer", "example":1 } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/discoverySNMP" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The properties of the updated SNMP access profile.", "type":"array", "items":{ "$ref":"#/components/schemas/discoverySNMPRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-discovery-Snmp-{id}-put", "x-filename-id":"api-discovery-snmp-id-put" }, "delete":{ "tags":[ "Device Discovery/SNMP Access" ], "summary":"Delete an SNMP Access Profile", "description":"Deletes the SNMP access profile that matches the specified ID.", "operationId":"discovery::SNMP::delete", "parameters":[ { "name":"id", "in":"path", "description":"The discovery SNMP access profile ID.", "required":true, "schema":{ "type":"integer", "example":2 } } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-discovery-Snmp-{id}-delete", "x-filename-id":"api-discovery-snmp-id-delete" } }, "/api/discovery/Snmp":{ "get":{ "tags":[ "Device Discovery/SNMP Access" ], "summary":"Get Discovery SNMP Access Profiles", "description":"Gets the discovery SNMP access profiles that match the specified parameters. If no parameters are specified, all discovery SNMP access profiles are returned.", "operationId":"discovery::SNMP::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of discovery SNMP access profiles that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/discoverySNMPRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-discovery-Snmp-get", "x-filename-id":"api-discovery-snmp-get" }, "post":{ "tags":[ "Device Discovery/SNMP Access" ], "summary":"Create an SNMP Access Profile", "description":"Creates a new SNMP access profile.
The minimum required properties in the request body are:\n ", "operationId":"discovery::SNMP::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/discoverySNMP" } ], "required":[ "Description", "DeviceZoneID", "SNMPVersion", "MTU", "SNMPPort", "PriorityOrder" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The properties of the new SNMP access profile.", "type":"array", "items":{ "$ref":"#/components/schemas/discoverySNMPRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-discovery-Snmp-post", "x-filename-id":"api-discovery-snmp-post" } }, "/api/discovery/Snmp/readForSelect":{ "get":{ "tags":[ "Device Discovery/SNMP Access" ], "summary":"Get Discovery SNMP Access Profiles for Combo Boxes and Item Selectors", "description":"Gets discovery SNMP access profiles in a format suitable for combo boxes and item selectors.", "operationId":"discovery::SNMP::readForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of discovery SNMP access profiles.", "type":"array", "items":{ "$ref":"#/components/schemas/discoverySNMPReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-discovery-Snmp-readForSelect-get", "x-filename-id":"api-discovery-snmp-readforselect-get" } }, "/api/discovery/Snmp/updateOrder":{ "get":{ "tags":[ "Device Discovery/SNMP Access" ], "summary":"Update Priority Order of SNMP Access", "description":"Updates the priority order of SNMP access.", "operationId":"discovery::SNMP::updateOrder", "parameters":[ { "name":"NewOrder", "in":"query", "description":"The new order of SNMP IDs in array format encoded in JSON string representation.", "required":true, "schema":{ "type":"string", "example":"[\"1\",\"1001\",\"1000\"]" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "success":{ "description":"Whether the operation was a success (true) or failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message.", "type":"string", "example":"Updated Order" } } } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-discovery-Snmp-updateOrder-get", "x-filename-id":"api-discovery-snmp-updateorder-get" } }, "/api/event/customEventFields/{id}":{ "get":{ "tags":[ "Event/Custom Event Fields" ], "summary":"Get a Custom Event Field by ID", "description":"Gets the custom event field that matches the specified ID and query parameters.", "operationId":"event::CustomEventFields::readBy_ID", "parameters":[ { "name":"id", "in":"path", "description":"The custom event field ID.", "required":true, "schema":{ "type":"integer", "example":7948575 } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The properties of the specified custom event field.", "type":"array", "items":{ "$ref":"#/components/schemas/eventCustomEventFieldsReadByID" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-customEventFields-{id}-get", "x-filename-id":"api-event-customeventfields-id-get" }, "put":{ "tags":[ "Event/Custom Event Fields" ], "summary":"Update a Custom Event Field", "description":"Updates the properties of the custom event field that matches the specified ID.", "operationId":"event::CustomEventFields::update", "parameters":[ { "name":"id", "in":"path", "description":"The custom event field ID.", "required":true, "schema":{ "type":"integer", "example":7948575 } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/eventCustomEventFields" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The properties of the updated event.", "type":"array", "items":{ "$ref":"#/components/schemas/eventCustomEventFieldsReadByID" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-customEventFields-{id}-put", "x-filename-id":"api-event-customeventfields-id-put" }, "delete":{ "tags":[ "Event/Custom Event Fields" ], "summary":"Delete a Custom Event Field", "description":"Deletes the custom event field that matches the specified ID.", "operationId":"event::CustomEventFields::delete", "parameters":[ { "name":"id", "in":"path", "description":"The custom event field ID.", "required":true, "schema":{ "type":"integer", "example":7948575 } } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-customEventFields-{id}-delete", "x-filename-id":"api-event-customeventfields-id-delete" } }, "/api/event/customEventFields":{ "get":{ "tags":[ "Event/Custom Event Fields" ], "summary":"Get Custom Event Fields", "description":"Gets the custom event fields that match the specified parameters. If no parameters are specified, all fields are returned. Oracle recommends using filtering and pagination parameters to limit the results.", "operationId":"event::CustomEventFields::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of events that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/eventCustomEventFieldsReadByID" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-customEventFields-get", "x-filename-id":"api-event-customeventfields-get" }, "post":{ "tags":[ "Event/Custom Event Fields" ], "summary":"Create a Custom Event Field", "description":"Creates a new custom event field.\n
The minimum required properties in the request body are:\n ", "operationId":"event::CustomEventFields::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "ShardID":{ "$ref":"#/components/schemas/eventCustomEventFields" } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The properties of the new custom event field.", "type":"array", "items":{ "$ref":"#/components/schemas/eventCustomEventFieldsReadByID" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-customEventFields-post", "x-filename-id":"api-event-customeventfields-post" } }, "/api/event/customEventFields/readForSelect":{ "get":{ "tags":[ "Event/Custom Event Fields" ], "summary":"Get Custom Event Fields for Combo Boxes and Item Selectors", "description":"Gets custom event fields in a format suitable for combo boxes and item selectors.", "operationId":"event::CustomEventFields::readForSelect", "parameters":[ { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/query" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/eventCustomEventFieldsReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-customEventFields-readForSelect-get", "x-filename-id":"api-event-customeventfields-readforselect-get" } }, "/api/event/Events/{id}":{ "get":{ "tags":[ "Event/Events" ], "summary":"Get an Event by ID", "description":"Gets the event that matches the specified ID and query parameters.", "operationId":"event::Events::readBy_ID", "parameters":[ { "name":"id", "in":"path", "description":"The event ID.", "required":true, "schema":{ "type":"integer", "example":7948575 } }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "name":"FilterType", "in":"query", "description":"The type of filter. Possible values are:\n\nThe default value is TEL (Transient Event List).", "required":false, "schema":{ "type":"string" } }, { "name":"FilterValue", "in":"query", "description":"The value of the filter. You can use a filter ID, a device name, metadata with the MetaType FilterGroupID, or an SQL where clause.", "required":false, "schema":{ "type":"string" } }, { "name":"FilterGroupID", "in":"query", "description":"The filter group of the filter. This parameter is required when FilterType is set to FilterId or MetaTag, otherwise it is optional.", "required":false, "schema":{ "type":"integer" } }, { "name":"DisplayID", "in":"query", "description":"The ID of the display used to determine the columns selected.", "required":false, "schema":{ "type":"integer", "example":1 } }, { "name":"ShardID", "in":"query", "description":"The shard ID to query. Default value is 1.", "required":false, "schema":{ "type":"integer", "example":1 } }, { "name":"DateFrom", "in":"query", "description":"The beginning of the date range in the format yyyy-mm-dd.", "required":false, "schema":{ "type":"string" } }, { "name":"DateTo", "in":"query", "description":"The end of the date range in the format yyyy-mm-dd.", "required":false, "schema":{ "type":"string" } }, { "name":"QuerySort", "in":"query", "description":"This parameter indicates the way the event field values are sorted. The allowed values are frequency and alphanumeric values.", "required":false, "schema":{ "type":"string" } }, { "name":"DisableConversions", "in":"query", "description":"Whether the event list value conversions have to be disabled or not. The default value is 0, which overrides the display setting.", "required":false, "schema":{ "type":"boolean" } }, { "name":"ReadSeveritiesOnly", "in":"query", "description":"Read severities only and prevent returning events. The default value is 0.", "required":false, "schema":{ "type":"integer" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The properties of the specified event.", "type":"array", "items":{ "$ref":"#/components/schemas/eventEventsReadByID" } }, "metaData":{ "$ref":"#/components/schemas/eventEventsReadByIDMetaData" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Events-{id}-get", "x-filename-id":"api-event-events-id-get" }, "put":{ "tags":[ "Event/Events" ], "summary":"Update an Event", "description":"Updates the properties of the event that matches the specified ID.", "operationId":"event::Events::update", "parameters":[ { "name":"id", "in":"path", "description":"The event ID.", "required":true, "schema":{ "type":"integer", "example":7948575 } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "ShardID":{ "$ref":"#/components/schemas/eventEventsReadData/properties/ShardID" }, "DisableConversions":{ "description":"Whether the event list value conversions have to be disabled or not. The default value is 0, which overrides the display setting.", "type":"integer", "example":0 } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The properties of the updated event.", "type":"array", "items":{ "$ref":"#/components/schemas/eventEventsReadByID" } }, "metaData":{ "$ref":"#/components/schemas/eventEventsReadByIDMetaData" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Events-{id}-put", "x-filename-id":"api-event-events-id-put" }, "delete":{ "tags":[ "Event/Events" ], "summary":"Delete an Event", "description":"Deletes the event that matches the specified ID.", "operationId":"event::Events::delete", "parameters":[ { "name":"id", "in":"path", "description":"The event ID.", "required":true, "schema":{ "type":"integer", "example":7948575 } } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Events-{id}-delete", "x-filename-id":"api-event-events-id-delete" } }, "/api/event/Events":{ "get":{ "tags":[ "Event/Events" ], "summary":"Get Events", "description":"Gets the events that match the specified parameters. If no parameters are specified, all events are returned. Oracle recommends using filtering and pagination parameters to limit the results.", "operationId":"event::Events::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "name":"FilterType", "in":"query", "description":"The type of filter. Possible values are:\n\nThe default value is TEL (Transient Event List).", "required":false, "schema":{ "type":"string" } }, { "name":"FilterValue", "in":"query", "description":"The value of the filter. You can use a filter ID, a device name, metadata with the MetaType FilterGroupID, or an SQL where clause.", "required":false, "schema":{ "type":"string" } }, { "name":"FilterGroupID", "in":"query", "description":"The filter group of the filter. This parameter is required when FilterType is set to FilterId or MetaTag, otherwise it is optional.", "required":false, "schema":{ "type":"integer" } }, { "name":"DisplayID", "in":"query", "description":"The ID of the display used to determine the columns selected.", "required":false, "schema":{ "type":"integer", "example":1 } }, { "name":"ShardID", "in":"query", "description":"The shard ID to query. Default value is 1.", "required":false, "schema":{ "type":"integer", "example":1 } }, { "name":"DateFrom", "in":"query", "description":"The beginning of the date range in the format yyyy-mm-dd.", "required":false, "schema":{ "type":"string" } }, { "name":"DateTo", "in":"query", "description":"The end of the date range in the format yyyy-mm-dd.", "required":false, "schema":{ "type":"string" } }, { "name":"QuerySort", "in":"query", "description":"This parameter indicates the way the event field values are sorted. The allowed values are frequency and alphanumeric values.", "required":false, "schema":{ "type":"string" } }, { "name":"DisableConversions", "in":"query", "description":"Whether the event list value conversions have to be disabled or not. The default value is 0, which overrides the display setting.", "required":false, "schema":{ "type":"boolean" } }, { "name":"ReadSeveritiesOnly", "in":"query", "description":"Read severities only and prevent returning events. The default value is 0.", "required":false, "schema":{ "type":"integer" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of events that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/eventEventsReadData" } }, "metaData":{ "description":"The metadata associated with the method.", "type":"array", "items":{ "$ref":"#/components/schemas/eventEventsReadMetaData" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Events-get", "x-filename-id":"api-event-events-get" }, "post":{ "tags":[ "Event/Events" ], "summary":"Create an Event", "description":"Creates a new event. If it is a duplicate event, the Count, Severity, LastReported, EventCategory, and Summary fields of the existing event are updated rather than creating another event. This endpoint does not support custom deduplication.", "operationId":"event::Events::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "ShardID":{ "$ref":"#/components/schemas/eventEventsReadData/properties/ShardID" } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The properties of the new event.", "type":"array", "items":{ "$ref":"#/components/schemas/eventEventsReadData" } }, "metaData":{ "description":"The metadata associated with the method.", "type":"array", "items":{ "$ref":"#/components/schemas/eventEventsReadMetaData" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Events-post", "x-filename-id":"api-event-events-post" } }, "/api/event/Events/readFields":{ "get":{ "tags":[ "Event/Events" ], "summary":"Get Event Filter Fields", "description":"Gets the event filter fields. They come from either EventDisplayColumns for a particular display or from the Alarm table for all displays.", "operationId":"event::Events::readFields", "parameters":[ { "name":"id", "in":"query", "description":"The display ID. If no ID is provided, it defaults to the DefaultDisplayID.", "required":false, "schema":{ "type":"integer", "example":1002 } }, { "name":"DisableConversions", "in":"query", "description":"Optionally disables event list value conversions. It defaults to the value saved in the display.", "required":false, "schema":{ "type":"integer", "example":0 } }, { "name":"Option", "in":"query", "description":"Option indicates which list of fields to return - the standard list of the most frequently used fields, or all fields\n\nAllowed Values:\n- standard\n- advanced", "required":false, "schema":{ "type":"string", "example":"standard" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "success":{ "description":"Whether the operation was a success (true) or failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message.", "type":"string", "example":"Loaded 1 entries" }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"8" }, "data":{ "description":"The list of event filter fields.", "type":"array", "items":{ "$ref":"#/components/schemas/eventEventsReadFields" }, "example":[ { "Field":"EventID", "Type":"Number", "Null":"NO", "Key":"PRI", "Default":"", "Extra":"auto_increment", "ColumnName":"EventID", "Expression":"Number", "FieldDescription":"EventID - Number" }, { "Field":"Node", "Type":"String", "Null":"NO", "Key":"MUL", "Default":"", "Extra":" ", "ColumnName":"Device", "Expression":"String", "FieldDescription":"Node - String" }, { "Field":"EventType", "Type":"String", "Null":"NO", "Key":"MUL", "Default":" ", "Extra":" ", "ColumnName":"Event Type", "Expression":"String", "FieldDescription":"EventType - String" }, { "Field":"Summary", "Type":"String", "Null":"NO", "Key":" ", "Default":" ", "Extra":" ", "ColumnName":"Event Text", "Expression":"String", "FieldDescription":"Summary - String" }, { "Field":"Count", "Type":"Number", "Null":"NO", "Key":" ", "Default":" ", "Extra":" ", "ColumnName":"Count", "Expression":"Number", "FieldDescription":"Count - Number" }, { "Field":"FirstReported", "Type":"DateTime", "Null":"NO", "Key":" ", "Default":" ", "Extra":" ", "ColumnName":"First Occurred", "Expression":"String", "FieldDescription":"FirstReported - DateTime" }, { "Field":"LastReported", "Type":"DateTime", "Null":"NO", "Key":" ", "Default":" ", "Extra":" ", "ColumnName":"Last Occurred", "Expression":"String", "FieldDescription":"LastReported - DateTime" }, { "Field":"LastChanged", "Type":"DateTime", "Null":"NO", "Key":" ", "Default":" ", "Extra":" ", "ColumnName":"Last Changed", "Expression":"String", "FieldDescription":"LastChanged - DateTime" } ] } } } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Events-readFields-get", "x-filename-id":"api-event-events-readfields-get" } }, "/api/event/Events/readFieldsForSelect":{ "get":{ "tags":[ "Event/Events" ], "summary":"Get Fields Associated to Events Table in Event Schema", "description":"Gets the list of fields associated to the Events table in the Event schema.", "operationId":"event::Events::readFieldsForSelect", "parameters":[ { "name":"id", "in":"query", "description":"The column name to filter the list on.", "required":false, "schema":{ "type":"integer", "example":1002 } }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of fields associated to the Events table in the Event schema.", "type":"array", "items":{ "$ref":"#/components/schemas/eventEventsReadFieldsForSelect" }, "example":[ { "Field":"Ack", "FieldDescription":"Ack - tinyint unsigned", "Type":"tinyint unsigned" }, { "Field":"Action", "FieldDescription":"Action - varchar(255)", "Type":"varchar(255)" }, { "Field":"Actor", "FieldDescription":"Actor - varchar(255)", "Type":"varchar(255)" }, { "Field":"Count", "FieldDescription":"Count - int unsigned", "Type":"int unsigned" }, { "Field":"Customer", "FieldDescription":"Customer - varchar(255)", "Type":"varchar(255)" }, { "Field":"Department", "FieldDescription":"Department - varchar(255)", "Type":"varchar(255)" }, { "Field":"Details", "FieldDescription":"Details - text", "Type":"text" }, { "Field":"DeviceType", "FieldDescription":"DeviceType - varchar(255)", "Type":"varchar(255)" }, { "Field":"Duration", "FieldDescription":"Duration - decimal(13,3) unsigned", "Type":"decimal(13,3) unsigned" }, { "Field":"EscalationFlag", "FieldDescription":"EscalationFlag - tinyint unsigned", "Type":"tinyint unsigned" }, { "Field":"EventCategory", "FieldDescription":"EventCategory - tinyint unsigned", "Type":"tinyint unsigned" }, { "Field":"EventID", "FieldDescription":"EventID - bigint unsigned", "Type":"bigint unsigned" }, { "Field":"EventKey", "FieldDescription":"EventKey - varchar(255)", "Type":"varchar(255)" }, { "Field":"EventType", "FieldDescription":"EventType - varchar(255)", "Type":"varchar(255)" }, { "Field":"ExpireTime", "FieldDescription":"ExpireTime - int unsigned", "Type":"int unsigned" }, { "Field":"FirstReported", "FieldDescription":"FirstReported - decimal(13,3) unsigned", "Type":"decimal(13,3) unsigned" }, { "Field":"GeoLocation", "FieldDescription":"GeoLocation - point", "Type":"point" }, { "Field":"GeoPath", "FieldDescription":"GeoPath - linestring", "Type":"linestring" }, { "Field":"IPAddress", "FieldDescription":"IPAddress - varchar(255)", "Type":"varchar(255)" }, { "Field":"LastChanged", "FieldDescription":"LastChanged - decimal(13,3) unsigned", "Type":"decimal(13,3) unsigned" }, { "Field":"LastReported", "FieldDescription":"LastReported - decimal(13,3) unsigned", "Type":"decimal(13,3) unsigned" }, { "Field":"Location", "FieldDescription":"Location - varchar(255)", "Type":"varchar(255)" }, { "Field":"Method", "FieldDescription":"Method - varchar(255)", "Type":"varchar(255)" }, { "Field":"Node", "FieldDescription":"Node - varchar(255)", "Type":"varchar(255)" }, { "Field":"OrigSeverity", "FieldDescription":"OrigSeverity - tinyint unsigned", "Type":"tinyint unsigned" } ] } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Events-readFieldsForSelect-get", "x-filename-id":"api-event-events-readfieldsforselect-get" } }, "/api/event/Events/readSeverities":{ "get":{ "tags":[ "Event/Events" ], "summary":"Get Event Severities", "description":"Gets the event severities.", "operationId":"event::Events::readSeverities", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "name":"FilterType", "in":"query", "description":"The type of filter. Possible values are:\n\nThe default value is TEL (Transient Event List).", "required":false, "schema":{ "type":"string" } }, { "name":"FilterValue", "in":"query", "description":"The value of the filter. You can use a filter ID, a device name, metadata with the MetaType FilterGroupID, or an SQL where clause.", "required":false, "schema":{ "type":"string" } }, { "name":"FilterGroupID", "in":"query", "description":"The filter group of the filter. This parameter is required when FilterType is set to FilterId or MetaTag, otherwise it is optional.", "required":false, "schema":{ "type":"integer" } }, { "name":"DisplayID", "in":"query", "description":"The ID of the display used to determine the columns selected.", "required":false, "schema":{ "type":"integer", "example":1 } }, { "name":"ShardID", "in":"query", "description":"The shard ID to query. Default value is 1.", "required":false, "schema":{ "type":"integer", "example":1 } }, { "name":"DateFrom", "in":"query", "description":"The beginning of the date range in the format yyyy-mm-dd.", "required":false, "schema":{ "type":"string" } }, { "name":"DateTo", "in":"query", "description":"The end of the date range in the format yyyy-mm-dd.", "required":false, "schema":{ "type":"string" } }, { "name":"QuerySort", "in":"query", "description":"This parameter indicates the way the event field values are sorted. The allowed values are frequency and alphanumeric values.", "required":false, "schema":{ "type":"string" } }, { "name":"DisableConversions", "in":"query", "description":"Whether the event list value conversions have to be disabled or not. The default value is 0, which overrides the display setting.", "required":false, "schema":{ "type":"boolean" } }, { "name":"ReadSeveritiesOnly", "in":"query", "description":"Read severities only and prevent returning events. The default value is 0.", "required":false, "schema":{ "type":"integer", "example":1 } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of all severity types and the number of events of each severity.", "type":"object", "example":{ "normal":5, "unknown":0, "info":1, "minor":1589, "major":809, "critical":171, "all":2575, "sum":3608082 } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Events-readSeverities-get", "x-filename-id":"api-event-events-readseverities-get" } }, "/api/event/DisplayConversions/{id}":{ "get":{ "tags":[ "Event/Conversions" ], "summary":"Get an Event Display Conversion by Field Name", "description":"Gets the event display conversion that matches the specified field name.", "operationId":"event::DisplayConversions::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The field name to retrieve the conversion for.", "required":true, "schema":{ "type":"string", "example":"EventCategory" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/eventDisplayConversionRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-DisplayConversions-{id}-get", "x-filename-id":"api-event-displayconversions-id-get" }, "put":{ "tags":[ "Event/Conversions" ], "summary":"Update an Event Display Conversion", "description":"Update the properties of the event display conversion that matches the specified field name.", "operationId":"event::DisplayConversions::update", "parameters":[ { "name":"id", "in":"path", "description":"The field name to retrieve conversions for.", "required":true, "schema":{ "type":"string", "example":"EventCategory" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/eventDisplayConversion" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the updated event display conversion.", "type":"array", "items":{ "$ref":"#/components/schemas/eventDisplayConversionRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-DisplayConversions-{id}-put", "x-filename-id":"api-event-displayconversions-id-put" }, "delete":{ "tags":[ "Event/Conversions" ], "summary":"Delete an Event Display Conversion", "description":"Deletes the event display conversion that matches the specified field name.", "operationId":"event::DisplayConversions::delete", "parameters":[ { "name":"id", "in":"path", "description":"The field name to retrieve conversions for.", "required":true, "schema":{ "type":"string", "example":"EventCategory" } } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-DisplayConversions-{id}-delete", "x-filename-id":"api-event-displayconversions-id-delete" } }, "/api/event/DisplayConversions":{ "get":{ "tags":[ "Event/Conversions" ], "summary":"Get Event Display Conversions", "description":"Gets the event display conversions that match the specified parameters. If no parameters are specified, all event display conversions are returned.", "operationId":"event::DisplayConversion::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of event display conversions that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/eventDisplayConversionRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-DisplayConversions-get", "x-filename-id":"api-event-displayconversions-get" }, "post":{ "tags":[ "Event/Conversions" ], "summary":"Create an Event Display Conversion", "description":"Creates a new event display conversion.
The minimum required properties in the request body are:\n \nCaution: If you add a display conversion for a field that is used as a token in an event tool path, you must update the event tool to add Raw to the end of the field name.\n
For example, if you create a conversion for ZoneID, you must update the paths for the Device Overview and View Metric tools to use <ZoneIDRaw> instead of <ZoneID>.\n
If you later disable the conversion, you do not have to update the tool path again. The path will still work with the Raw field name, even when the conversion is disabled. If you delete the conversion, you must update the path to remove Raw.\n
See the /api/event/tools endpoints for more information about getting, updating, and creating event tools.", "operationId":"event::DisplayConversions::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/eventDisplayConversion", "required":[ "Field", "Conversions" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new event display conversion.", "type":"array", "items":{ "$ref":"#/components/schemas/eventDisplayConversionRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-DisplayConversions-post", "x-filename-id":"api-event-displayconversions-post" } }, "/api/event/DisplayConversions/readFieldsForSelect":{ "get":{ "tags":[ "Event/Conversions" ], "summary":"Get Event Fields from Events for Combo Boxes", "description":"Gets event fields from events in a format suitable for combo boxes and item selectors by calling the event/Events/readFieldsForSelect endpoint and converting the response to the suitable form.", "operationId":"event::DisplayConversion::readFieldsForSelect", "parameters":[ { "name":"id", "in":"query", "description":"The column name to filter the list on.", "required":true, "schema":{ "type":"string", "example":"EventCategory" } }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of event fields from events.", "type":"array", "items":{ "$ref":"#/components/schemas/eventDisplayConversionReadFieldsForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-DisplayConversions-readFieldsForSelect-get", "x-filename-id":"api-event-displayconversions-readfieldsforselect-get" } }, "/api/event/DisplayConversions/readForSelect":{ "get":{ "tags":[ "Event/Conversions" ], "summary":"Get Conversions for a Specific Field for Combo Boxes and Item Selectors", "description":"Gets the conversions for a specific field in a format suitable for combo boxes and item selectors.", "operationId":"event::DisplayConversion::readForSelect", "parameters":[ { "name":"id", "in":"query", "description":"The column name to filter the list on.", "required":true, "schema":{ "type":"string", "example":"EventCategory" } }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of conversions for the specified field.", "type":"array", "items":{ "$ref":"#/components/schemas/eventDisplayConversionsReadForSelect" }, "example":[ { "CompareValue":1, "DisplayValue":"Resolution" }, { "CompareValue":2, "DisplayValue":"Problem" }, { "CompareValue":3, "DisplayValue":"Discrete" } ] } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-DisplayConversions-readForSelect-get", "x-filename-id":"api-event-displayconversions-readforselect-get" } }, "/api/event/Displays/{id}":{ "get":{ "tags":[ "Event/Displays" ], "summary":"Get an Event Display by ID", "description":"Gets the event display that matches the specified ID.", "operationId":"event::Displays::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The event display ID.", "required":true, "schema":{ "type":"integer", "example":"1" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/eventDisplayRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Displays-{id}-get", "x-filename-id":"api-event-displays-id-get" }, "put":{ "tags":[ "Event/Displays" ], "summary":"Update an Event Display", "description":"Updates the properties of the event display that matches the specified ID.", "operationId":"event::Displays::update", "parameters":[ { "name":"id", "in":"path", "description":"The event display ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/eventDisplay" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the updated event display.", "type":"array", "items":{ "$ref":"#/components/schemas/eventDisplayRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Displays-{id}-put", "x-filename-id":"api-event-displays-id-put" }, "delete":{ "tags":[ "Event/Displays" ], "summary":"Delete an Event Display", "description":"Deletes the event display that matches the specified ID.", "operationId":"event::Displays::delete", "parameters":[ { "name":"id", "in":"path", "description":"The event display ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Displays-{id}-delete", "x-filename-id":"api-event-displays-id-delete" } }, "/api/event/Displays":{ "get":{ "tags":[ "Event/Displays" ], "summary":"Get Event Displays", "description":"Gets the event displays that match the specified parameters. If no parameters are specified, all event displays are returned.", "operationId":"event::Displays::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of event displays that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/eventDisplayRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Displays-get", "x-filename-id":"api-event-displays-get" }, "post":{ "tags":[ "Event/Displays" ], "summary":"Create an Event Display", "description":"Creates a new event display.
The minimum required properties in the request body are:\n ", "operationId":"event::Displays::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/eventDisplay", "required":[ "DisplayName", "OwnerUserID", "OwnerUserGroupID", "DisableConversions", "DisplayColumns" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new event display.", "type":"array", "items":{ "$ref":"#/components/schemas/eventDisplayRead" } }, "total":{ "description":"The total number of results regardless of paging", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Displays-post", "x-filename-id":"api-event-displays-post" } }, "/api/event/Displays/readForSelect":{ "get":{ "tags":[ "Event/Displays" ], "summary":"Get Event Displays for Combo Boxes and Item Selectors", "description":"Gets event displays in a format suitable for combo boxes and item selectors.", "operationId":"event::Displays::readForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of event displays.", "type":"array", "items":{ "$ref":"#/components/schemas/eventDisplaysReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Displays-readForSelect-get", "x-filename-id":"api-event-displays-readforselect-get" } }, "/api/event/Displays/readAllColumns":{ "get":{ "tags":[ "Event/Displays" ], "summary":"Get All Columns for New Displays", "description":"Gets all the columns for new displays.", "operationId":"event::Displays::readAllColumns", "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of all the columns for new displays.", "type":"array", "items":{ "$ref":"#/components/schemas/eventDisplayReadAllColumns" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Displays-readAllColumns-get", "x-filename-id":"api-event-displays-readallcolumns-get" } }, "/api/event/EventJournals":{ "get":{ "tags":[ "Event/Journals" ], "summary":"Get Journal Entries", "description":"Gets the journal entries of a specific event that matches the specified parameters. If no parameters are specified, all journal entries of that event are returned.", "operationId":"event::EventJournals::read", "parameters":[ { "name":"EventID", "in":"query", "description":"The event ID of the event whose journal entries have to be returned.", "required":true, "schema":{ "type":"integer" } }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of journal entries of the specified event.", "type":"array", "items":{ "$ref":"#/components/schemas/eventEventJournalsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-EventJournals-get", "x-filename-id":"api-event-eventjournals-get" }, "post":{ "tags":[ "Event/Journals" ], "summary":"Create a Journal Entry", "description":"Creates a new journal entry for a specified event.
The minimum required properties in the request body are:\n ", "operationId":"event::EventJournals::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/eventEventJournals", "required":[ "EventID", "JournalEntry" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new journal entry.", "type":"array", "items":{ "$ref":"#/components/schemas/eventEventJournalsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-EventJournals-post", "x-filename-id":"api-event-eventjournals-post" } }, "/api/event/Filters/{id}":{ "get":{ "tags":[ "Event/Event Filters" ], "summary":"Get an Event Filter by ID", "description":"Gets the event filter that matches the specified ID.", "operationId":"event::Filters::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The event filter ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/eventFiltersRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Filters-{id}-get", "x-filename-id":"api-event-filters-id-get" }, "put":{ "tags":[ "Event/Event Filters" ], "summary":"Update an Event Filter", "description":"Updates the properties of the event filter that matches the specified ID.", "operationId":"event::Filters::update", "parameters":[ { "name":"id", "in":"path", "description":"The event filter ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/eventFilters" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the updated event filter.", "type":"array", "items":{ "$ref":"#/components/schemas/eventFiltersRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Filters-{id}-put", "x-filename-id":"api-event-filters-id-put" }, "delete":{ "tags":[ "Event/Event Filters" ], "summary":"Delete an Event Filter", "description":"Deletes the event filter that matches the specified ID.", "operationId":"event::Filters::delete", "parameters":[ { "name":"id", "in":"path", "description":"The event filter ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Filters-{id}-delete", "x-filename-id":"api-event-filters-id-delete" } }, "/api/event/Filters":{ "get":{ "tags":[ "Event/Event Filters" ], "summary":"Get Event Filters", "description":"Gets the event filters that match the specified parameters. If no parameters are specified, all event filters are returned.", "operationId":"event::Filters::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of event filters that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/eventFiltersRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Filters-get", "x-filename-id":"api-event-filters-get" }, "post":{ "tags":[ "Event/Event Filters" ], "summary":"Create an Event Filter", "description":"Creates a new event filter.
The minimum required properties in the request body are:\n ", "operationId":"event::Filters::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/eventFilters", "required":[ "FilterName", "OwnerUserID", "OwnerUserGroupID", "DisplayID", "ShardID", "ShowSymptoms", "Filter" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new event filter.", "type":"array", "items":{ "$ref":"#/components/schemas/eventFiltersRead" } }, "total":{ "description":"The total number of results regardless of paging", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Filters-post", "x-filename-id":"api-event-filters-post" } }, "/api/event/Filters/readForSelect":{ "get":{ "tags":[ "Event/Event Filters" ], "summary":"Get Event Filters for Combo Boxes and Item Selectors", "description":"Gets event filters in a format suitable for combo boxes and item selectors.", "operationId":"event::Filters::readForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/query" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of event filters.", "type":"array", "items":{ "$ref":"#/components/schemas/eventFiltersReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Filters-readForSelect-get", "x-filename-id":"api-event-filters-readforselect-get" } }, "/api/event/FilterGroups/{id}":{ "get":{ "tags":[ "Event/Event Filter Groups" ], "summary":"Get an Event Filter Group by ID", "description":"Gets the event filter group that matches the specified ID.", "operationId":"event::FilterGroups::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The event filter group ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" }, { "name":"readChildren", "in":"query", "description":"Whether to return only the properties of the children of the event group for a tree display (true) or the properties of the requested group for a form display (false).", "required":false, "schema":{ "type":"boolean" }, "example":false } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/eventFilterGroupsReadByID" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-FilterGroups-{id}-get", "x-filename-id":"api-event-filtergroups-id-get" }, "put":{ "tags":[ "Event/Event Filter Groups" ], "summary":"Update an Event Filter Group", "description":"Updates the properties of the event filter group that matches the specified ID.", "operationId":"event::FilterGroups::update", "parameters":[ { "name":"id", "in":"path", "description":"The event filter group ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/eventFilterGroups" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the updated event filter group.", "type":"array", "items":{ "$ref":"#/components/schemas/eventFilterGroupsReadByID" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-FilterGroups-{id}-put", "x-filename-id":"api-event-filtergroups-id-put" }, "delete":{ "tags":[ "Event/Event Filter Groups" ], "summary":"Delete an Event Filter Group", "description":"Deletes the event filter group that matches the specified ID.", "operationId":"event::FilterGroups::delete", "parameters":[ { "name":"id", "in":"path", "description":"The event filter group ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-FilterGroups-{id}-delete", "x-filename-id":"api-event-filtergroups-id-delete" } }, "/api/event/FilterGroups":{ "get":{ "tags":[ "Event/Event Filter Groups" ], "summary":"Get an Event Filter Group or Children of an Event Filter Group", "description":"Gets the details of an event filter group and its children.", "operationId":"event::FilterGroups::read", "parameters":[ { "$ref":"#/components/parameters/sort" }, { "name":"node", "in":"query", "required":true, "description":"The node of the event filter group to select from the tree. You can specify root or the numerical ID.", "schema":{ "type":"string", "example":"root" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The details of the event filter group.", "type":"array", "items":{ "$ref":"#/components/schemas/eventFilterGroupsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-FilterGroups-get", "x-filename-id":"api-event-filtergroups-get" }, "post":{ "tags":[ "Event/Event Filter Groups" ], "summary":"Create an Event Filter Group", "description":"Creates a new event filter group.
The minimum required properties in the request body are:\n ", "operationId":"event::FilterGroups::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/eventFilterGroups", "required":[ "FilterGroupName", "ParentFilterGroupID", "OwnerUserID", "OwnerUserGroupID", "Filters" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new event filter group.", "type":"array", "items":{ "$ref":"#/components/schemas/eventFilterGroupsReadByID" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-FilterGroups-post", "x-filename-id":"api-event-filtergroups-post" } }, "/api/event/FilterGroups/readForSelect":{ "get":{ "tags":[ "Event/Event Filter Groups" ], "summary":"Get Event Filter Groups for Combo Boxes and Item Selectors", "description":"Gets event filter groups in a format suitable for combo boxes and item selectors.", "operationId":"event::FilterGroups::readForSelect", "parameters":[ { "name":"id", "in":"query", "description":"The event filter group ID.", "required":false, "schema":{ "type":"integer", "format":"int32" }, "example":"1" }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/eventFilterGroupsReadForSelect" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-FilterGroups-readForSelect-get", "x-filename-id":"api-event-filtergroups-readforselect-get" } }, "/api/event/FilterGroups/readForTree":{ "get":{ "tags":[ "Event/Event Filter Groups" ], "summary":"Get Event Filter Groups for Tree Grids", "description":"Gets the event filter groups in a format suitable for tree grids.", "operationId":"event::FilterGroups::readForTree", "parameters":[ { "name":"id", "in":"query", "description":"The event filter group ID.", "required":false, "schema":{ "type":"integer", "format":"int32" }, "example":"1" }, { "name":"node", "in":"query", "description":"The node of the tree to get.", "required":false, "schema":{ "type":"string", "example":"root" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "oneOf":[ { "$ref":"#/components/schemas/eventFilterGroupsReadForTreeIDResponse" }, { "$ref":"#/components/schemas/eventFilterGroupsReadForTreeNodeResponse" } ] } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-FilterGroups-readForTree-get", "x-filename-id":"api-event-filtergroups-readfortree-get" } }, "/api/event/FilterGroups/readForTreeCombo":{ "get":{ "tags":[ "Event/Event Filter Groups" ], "summary":"Get Event Filter Groups for Tree Combos", "description":"Gets the event filter groups in a format suitable for tree combos.", "operationId":"event::FilterGroups::readForTreeCombo", "parameters":[ { "name":"id", "in":"query", "description":"The event filter group ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" }, { "name":"node", "in":"query", "description":"The node of the tree to get.", "required":true, "schema":{ "type":"string", "example":"root" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/eventFilterGroupsReadByID" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-FilterGroups-readForTreeCombo-get", "x-filename-id":"api-event-filtergroups-readfortreecombo-get" } }, "/api/event/FilterGroups/updateFilters":{ "put":{ "tags":[ "Event/Event Filter Groups" ], "summary":"Move or Copy Event Filters to a Different Group", "description":"Moves or copies event filters to a different group. To move, specify a source group in SourceFilterGroupID. To copy, do not specify a source group.", "operationId":"event::FilterGroups::updateFilters", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "id":{ "description":"The destination event filter group ID.", "type":"integer", "example":"3" }, "SourceFilterGroupID":{ "description":"The source event filter group ID. To move devices, specify an ID. To copy devices, do not use this parameter.", "type":"integer" }, "Filters":{ "$ref":"#/components/schemas/eventFilterGroups/properties/Filters" } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The destination event filter group with the moved or copied event filters.", "type":"array", "items":{ "$ref":"#/components/schemas/eventFilterGroupsUpdateMove" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-FilterGroups-updateFilters-put", "x-filename-id":"api-event-filtergroups-updatefilters-put" } }, "/api/event/FilterGroups/updateMove":{ "put":{ "tags":[ "Event/Event Filter Groups" ], "summary":"Move Event Filter Groups to a Different Parent", "description":"Moves the event filter groups listed in id to the parent specified in ParentFilterGroupID.", "operationId":"event::FilterGroups::updateMove", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/eventFilterGroupsUpdateMoveReqBody", "required":[ "id", "ParentFilterGroupID" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the parent event filter group.", "type":"array", "items":{ "$ref":"#/components/schemas/eventFilterGroupsUpdateMove" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-FilterGroups-updateMove-put", "x-filename-id":"api-event-filtergroups-updatemove-put" } }, "/api/event/ForensicViews/readFilterOptions":{ "get":{ "tags":[ "Event/Forensic Views" ], "summary":"Get Possible Values for a Field from the Events Table", "description":"Gets a list of possible values for the given field from the events table.", "operationId":"event::ForensicViews::readFilterOptions", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/query" }, { "name":"id", "in":"query", "description":"The value of the field to filter on.", "required":false, "schema":{ "type":"string" } }, { "name":"Field", "in":"query", "description":"The field from the Event.Events table.", "required":true, "schema":{ "type":"string" } }, { "name":"QuerySort", "in":"query", "description":"QuerySort indicates the way the event field values are sorted.
\nAllowed Values:\n", "required":true, "schema":{ "type":"string" } }, { "name":"DisableConversions", "in":"query", "description":"Whether the event list value conversions have to be disabled or not. The default value is 0, which overrides the display setting.", "required":false, "schema":{ "type":"boolean" } }, { "name":"DisplayID", "in":"query", "description":"The optional display ID for display conversion setting.", "required":false, "schema":{ "type":"integer" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":3 }, "data":{ "description":"The list of possible values for the given field from the events table.", "type":"array", "items":{ "type":"object", "properties":{ "Field":{ "description":"The value from the given field.", "type":"string", "example":"Packet Loss High with value 100.00 >= 1" }, "ValueID":{ "description":"The value from the given field.", "type":"string", "example":"Packet Loss High with value 100.00 >= 1" }, "Frequency":{ "description":"The number of times the value occurs.", "type":"integer", "example":"135" } } }, "example":[ { "Field":"Ping Jitter High with value 0.00 >= 0.0001", "ValueID":"Ping Jitter High with value 0.00 >= 0.0001", "Frequency":"208" }, { "Field":"Device Down with availability 0.00% == 0%", "ValueID":"Device Down with availability 0.00% == 0%", "Frequency":"155" }, { "Field":"Packet Loss High with value 100.00 >= 1", "ValueID":"Packet Loss High with value 100.00 >= 1", "Frequency":"135" } ] } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-ForensicViews-readFilterOptions-get", "x-filename-id":"api-event-forensicviews-readfilteroptions-get" } }, "/api/event/Mechanizations/{id}":{ "get":{ "tags":[ "Event/Mechanizations" ], "summary":"Get an Event Mechanization by ID", "description":"Gets the event mechanization that matches the specified ID.", "operationId":"event::Mechanizations::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The event mechanization ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/eventMechanizationsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Mechanizations-{id}-get", "x-filename-id":"api-event-mechanizations-id-get" }, "put":{ "tags":[ "Event/Mechanizations" ], "summary":"Update an Event Mechanization", "description":"Updates the properties of the event mechanization that matches the specified ID.", "operationId":"event::Mechanizations::update", "parameters":[ { "name":"id", "in":"path", "description":"The event mechanization ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/eventMechanizations" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the updated event mechanization.", "type":"array", "items":{ "$ref":"#/components/schemas/eventMechanizationsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Mechanizations-{id}-put", "x-filename-id":"api-event-mechanizations-id-put" }, "delete":{ "tags":[ "Event/Mechanizations" ], "summary":"Delete an Event Mechanization", "description":"Deletes the event mechanization that matches the specified ID.", "operationId":"event::Mechanizations::delete", "parameters":[ { "name":"id", "in":"path", "description":"The event mechanization ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Mechanizations-{id}-delete", "x-filename-id":"api-event-mechanizations-id-delete" } }, "/api/event/Mechanizations/":{ "get":{ "tags":[ "Event/Mechanizations" ], "summary":"Get Event Mechanizations", "description":"Gets the event mechanizations that match the specified parameters. If no parameters are specified, all event mechanizations are returned.", "operationId":"event::Mechanizations::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of event mechanizations that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/eventMechanizationsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Mechanizations--get", "x-filename-id":"api-event-mechanizations-get" }, "post":{ "tags":[ "Event/Mechanizations" ], "summary":"Create an Event Mechanization", "description":"Creates a new event mechanization.
The minimum required properties in the request body are:\n ", "operationId":"event::Mechanizations::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/eventMechanizations", "required":[ "EventMechanizationName", "Description", "Minutes", "Hours", "Days", "Months", "WeekDays", "StatusID", "StoredProcedure" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new event mechanization.", "type":"array", "items":{ "$ref":"#/components/schemas/eventMechanizationsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Mechanizations--post", "x-filename-id":"api-event-mechanizations-post" } }, "/api/event/Mechanizations/readForSelect":{ "get":{ "tags":[ "Event/Mechanizations" ], "summary":"Get Event Mechanizations for Combo Boxes and Item Selectors", "description":"Gets event mechanizations in a format suitable for combo boxes and item selectors.", "operationId":"event::Mechanizations::readForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/query" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of event mechanizations.", "type":"array", "items":{ "$ref":"#/components/schemas/eventMechanizationsReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Mechanizations-readForSelect-get", "x-filename-id":"api-event-mechanizations-readforselect-get" } }, "/api/event/Menus/{id}":{ "get":{ "tags":[ "Event/Event Menus" ], "summary":"Get an Event Menu by ID", "description":"Gets the event menu that matches the specified ID.", "operationId":"event::Menus::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The event menu ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/eventMenusReadByID" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Menus-{id}-get", "x-filename-id":"api-event-menus-id-get" }, "put":{ "tags":[ "Event/Event Menus" ], "summary":"Update an Event Menu", "description":"Updates the properties of the event menu that matches the specified ID.", "operationId":"event::Menus::update", "parameters":[ { "name":"id", "in":"path", "description":"The event menu ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/eventMenusUpdate" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The list of updated event menus.", "type":"array", "items":{ "type":"integer" }, "example":[ 1, 2, 3, 4 ] } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Menus-{id}-put", "x-filename-id":"api-event-menus-id-put" }, "delete":{ "tags":[ "Event/Event Menus" ], "summary":"Delete an Event Menu", "description":"Deletes the event menu that matches the specified ID.", "operationId":"event::Menus::delete", "parameters":[ { "name":"id", "in":"path", "description":"The event menu ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Menus-{id}-delete", "x-filename-id":"api-event-menus-id-delete" } }, "/api/event/Menus":{ "get":{ "tags":[ "Event/Event Menus" ], "summary":"Get Event Menus", "description":"Gets the event menus from a node.", "operationId":"event::Menus::read", "parameters":[ { "name":"node", "description":"The node specifies the event menu to retrieve. You can either get all event menus by specifying root or get a particular menu by specifying the menu ID.", "in":"query", "required":true, "schema":{ "type":"string", "example":"root" } }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of event menus.", "type":"array", "items":{ "$ref":"#/components/schemas/eventMenusRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Menus-get", "x-filename-id":"api-event-menus-get" }, "post":{ "tags":[ "Event/Event Menus" ], "summary":"Create an Event Menu", "description":"Creates a new event menu.
The minimum required properties in the request body are:\n ", "operationId":"event::Menus::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/eventMenus", "required":[ "MenuName", "UserGroupID", "DefaultMenu", "ParentMenuID", "Tools" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new event menu.", "type":"array", "items":{ "$ref":"#/components/schemas/eventMenusReadByID" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Menus-post", "x-filename-id":"api-event-menus-post" } }, "/api/event/Menus/readForTree":{ "get":{ "tags":[ "Event/Event Menus" ], "summary":"Get Event Menus for Tree Grids", "description":"Gets the event menus in a format suitable for tree grids.", "operationId":"event::Menus::readForTree", "parameters":[ { "name":"node", "description":"The node of the tree to get. You can specify root or the numerical menu ID.", "in":"query", "required":true, "schema":{ "type":"string", "example":"root" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of event menus.", "type":"array", "items":{ "$ref":"#/components/schemas/eventMenusReadForTree" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Menus-readForTree-get", "x-filename-id":"api-event-menus-readfortree-get" } }, "/api/event/Menus/readForMenu":{ "get":{ "tags":[ "Event/Event Menus" ], "summary":"Get Menu Items of an Event Menu", "description":"Gets the menu items of the specified event menu.", "operationId":"event::Menus::readForMenu", "parameters":[ { "name":"node", "description":"The node of the tree to get. You can specify root or the numerical event menu ID.", "in":"query", "required":true, "schema":{ "type":"string", "example":"root" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of menu items of the specified event menu.", "type":"array", "items":{ "$ref":"#/components/schemas/eventMenusReadForMenu" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Menus-readForMenu-get", "x-filename-id":"api-event-menus-readformenu-get" } }, "/api/event/Menus/updateTools":{ "put":{ "tags":[ "Event/Event Menus" ], "summary":"Move or Copy Event Menu Tools to a Different Menu", "description":"Moves or copies event menu tools to a different menu. To move, specify a source menu in SourceMenuID. To copy, do not specify a source menu.", "operationId":"event::Menus::updateTools", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "required":[ "id", "Tools" ], "properties":{ "id":{ "description":"The destination event menu ID.", "type":"integer", "example":"2", "required":true }, "SourceMenuID":{ "description":"The source event menu ID. To move event menu tools, specify an ID. To copy event menu tools, do not use this parameter.", "type":"integer", "example":"1" }, "Tools":{ "description":"The list of event menu tools.", "type":"array", "items":{ "type":"integer" }, "example":[ 1, 2 ], "required":true } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Menus-updateTools-put", "x-filename-id":"api-event-menus-updatetools-put" } }, "/api/event/Menus/updateMove":{ "put":{ "tags":[ "Event/Event Menus" ], "summary":"Move an Event Menu to a Different Parent", "description":"Moves the event menu specified using MenuID or MenuName to the parent specified in ParentMenuID.", "operationId":"event::Menus::updateMove", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/eventMenusUpdateMove" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the parent menu.", "type":"array", "items":{ "$ref":"#/components/schemas/eventMenusReadByID" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Menus-updateMove-put", "x-filename-id":"api-event-menus-updatemove-put" } }, "/api/event/MetaEvents/{id}":{ "get":{ "tags":[ "Event/Meta Events" ], "summary":"Get a Meta Event by ID", "description":"Gets the meta-event that matches the specified ID.", "operationId":"event::MetaEvents::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The meta-event ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/eventMetaEventsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-MetaEvents-{id}-get", "x-filename-id":"api-event-metaevents-id-get" }, "put":{ "tags":[ "Event/Meta Events" ], "summary":"Update a Meta Events", "description":"Update the properties of the meta-event that matches the specified ID.", "operationId":"event::MetaEvents::update", "parameters":[ { "name":"id", "in":"path", "description":"The meta-event ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/eventMetaEvents" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the updated meta-event.", "type":"array", "items":{ "$ref":"#/components/schemas/eventMetaEventsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-MetaEvents-{id}-put", "x-filename-id":"api-event-metaevents-id-put" }, "delete":{ "tags":[ "Event/Meta Events" ], "summary":"Delete a Meta Event", "description":"Deletes the meta-event that matches the specified ID.", "operationId":"event::MetaEvents::delete", "parameters":[ { "name":"id", "in":"path", "description":"The meta-event ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-MetaEvents-{id}-delete", "x-filename-id":"api-event-metaevents-id-delete" } }, "/api/event/MetaEvents/":{ "get":{ "tags":[ "Event/Meta Events" ], "summary":"Get Meta Events", "description":"Gets the meta-events that match the specified parameters. If no parameters are specified, all meta-events are returned.", "operationId":"event::MetaEvents::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of meta-events that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/eventMetaEventsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-MetaEvents--get", "x-filename-id":"api-event-metaevents-get" }, "post":{ "tags":[ "Event/Meta Events" ], "summary":"Create a Meta Events", "description":"Creates a new meta-event. At minimum, the MetaEventName property is required in the request body.", "operationId":"event::MetaEvents::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/eventMetaEvents", "required":[ "MetaEventName" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new meta-event.", "type":"array", "items":{ "$ref":"#/components/schemas/eventMetaEventsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-MetaEvents--post", "x-filename-id":"api-event-metaevents-post" } }, "/api/event/MetaEvents/readForSelect":{ "get":{ "tags":[ "Event/Meta Events" ], "summary":"Get Meta Events for Combo Boxes and Item Selectors", "description":"Gets meta-events in a format suitable for combo boxes and item selectors.", "operationId":"event::MetaEvents::readForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/query" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of meta-events.", "type":"array", "items":{ "$ref":"#/components/schemas/eventMetaEventsReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-MetaEvents-readForSelect-get", "x-filename-id":"api-event-metaevents-readforselect-get" } }, "/api/event/MetaEvents/readFields":{ "get":{ "tags":[ "Event/Meta Events" ], "summary":"Get All Fields from the Events Table", "description":"This method is deprecated. Use API/event/Events/readFields.", "deprecated":true, "operationId":"event::MetaEvents::readFields", "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of fields.", "type":"array", "items":{ "type":"object", "properties":{ "Field":{ "type":"string", "example":"EventID" }, "Type":{ "type":"string", "example":"bigint unsigned" }, "Default":{ "oneOf":[ { "type":"string" }, { "type":"integer" }, { "type":"boolean" }, { "type":"number" } ], "nullable":true, "example":"0" } } } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-MetaEvents-readFields-get", "x-filename-id":"api-event-metaevents-readfields-get" } }, "/api/event/Nodes/{id}":{ "get":{ "tags":[ "Event/CAPE Nodes" ], "summary":"Get a CAPE Node by ID", "description":"Gets the CAPE node that matches the specified ID.", "operationId":"event::Nodes::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The CAPE node ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/eventNodesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Nodes-{id}-get", "x-filename-id":"api-event-nodes-id-get" }, "put":{ "tags":[ "Event/CAPE Nodes" ], "summary":"Update a CAPE Node", "description":"Updates the properties of the CAPE node that matches the specified ID.", "operationId":"event::Nodes::update", "parameters":[ { "name":"id", "in":"path", "description":"The CAPE node ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/eventNodes" }, { "type":"object", "properties":{ "CommitLog":{ "description":"The commit message.", "type":"string" } } } ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the updated CAPE node.", "type":"array", "items":{ "$ref":"#/components/schemas/eventNodesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Nodes-{id}-put", "x-filename-id":"api-event-nodes-id-put" }, "delete":{ "tags":[ "Event/CAPE Nodes" ], "summary":"Delete a CAPE Node", "description":"Deletes the CAPE node that matches the specified ID.", "operationId":"event::Nodes::delete", "parameters":[ { "name":"id", "in":"path", "description":"The CAPE node ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Nodes-{id}-delete", "x-filename-id":"api-event-nodes-id-delete" } }, "/api/event/Nodes":{ "get":{ "tags":[ "Event/CAPE Nodes" ], "summary":"Get CAPE Nodes", "description":"Gets the CAPE nodes that match the specified parameters. If no parameters are specified, all CAPE nodes are returned.", "operationId":"event::Nodes::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of CAPE nodes that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/eventNodesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Nodes-get", "x-filename-id":"api-event-nodes-get" }, "post":{ "tags":[ "Event/CAPE Nodes" ], "summary":"Create a CAPE Node", "description":"Creates a new CAPE node.
The minimum required properties in the request body are:\n ", "operationId":"event::Nodes::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/eventNodes", "required":[ "NodeDescription", "NodeStateVerify", "NodeNextNode" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new cape node.", "type":"array", "items":{ "$ref":"#/components/schemas/eventNodesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Nodes-post", "x-filename-id":"api-event-nodes-post" } }, "/api/event/Nodes/readForSelect":{ "get":{ "tags":[ "Event/CAPE Nodes" ], "summary":"Get CAPE Nodes for Combo Boxes and Item Selectors", "description":"Gets CAPE nodes in a format suitable for combo boxes and item selectors.", "operationId":"event::Nodes::readForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of CAPE nodes.", "type":"array", "items":{ "$ref":"#/components/schemas/eventNodesReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Nodes-readForSelect-get", "x-filename-id":"api-event-nodes-readforselect-get" } }, "/api/event/Nodes/executeCheckSyntax":{ "post":{ "tags":[ "Event/CAPE Nodes" ], "summary":"Check Syntax for a CAPE Node", "description":"Runs the CAPE node file provided in the request body through the CheckSyntax utility and returns the result. The Content property is required in the request body.", "operationId":"event::Nodes::executeCheckSyntax", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "Content":{ "description":"The CAPE node content.", "type":"string" }, "FileName":{ "description":"The CAPE node name.", "type":"string" } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "message":{ "example":"Syntax Check OK" } } } ] } } } }, "default":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "success":{ "example":false }, "message":{ "example":"Syntax Check found errors" } } } ] } } } } }, "x-internal-id":"api-event-Nodes-executeCheckSyntax-post", "x-filename-id":"api-event-nodes-executechecksyntax-post" } }, "/api/event/Policies/{id}":{ "get":{ "tags":[ "Event/CAPE Policies" ], "summary":"Get a CAPE Policy by ID", "description":"Gets the CAPE policy that matches the specified ID.", "operationId":"event::Policies::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The CAPE policy ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/eventPoliciesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Policies-{id}-get", "x-filename-id":"api-event-policies-id-get" }, "put":{ "tags":[ "Event/CAPE Policies" ], "summary":"Update a CAPE Policy", "description":"Updates the properties of the CAPE policy that matches the specified ID.", "operationId":"event::Policies::update", "parameters":[ { "name":"id", "in":"path", "description":"The CAPE policy ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/eventPolicies" }, { "type":"object", "properties":{ "CommitLog":{ "description":"The commit message.", "type":"string" } } } ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the updated CAPE policy.", "type":"array", "items":{ "$ref":"#/components/schemas/eventPoliciesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Policies-{id}-put", "x-filename-id":"api-event-policies-id-put" }, "delete":{ "tags":[ "Event/CAPE Policies" ], "summary":"Delete a CAPE Policy", "description":"Deletes the CAPE policy that matches the specified ID.", "operationId":"event::Policies::delete", "parameters":[ { "name":"id", "in":"path", "description":"The CAPE policy ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Policies-{id}-delete", "x-filename-id":"api-event-policies-id-delete" } }, "/api/event/Policies":{ "get":{ "tags":[ "Event/CAPE Policies" ], "summary":"Get CAPE Policies", "description":"Gets the CAPE policies that match the specified parameters. If no parameters are specified, all CAPE policies are returned.", "operationId":"event::Policies::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of CAPE policies that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/eventPoliciesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Policies-get", "x-filename-id":"api-event-policies-get" }, "post":{ "tags":[ "Event/CAPE Policies" ], "summary":"Create a CAPE Policy", "description":"Creates a new CAPE policy.
The minimum required properties in the request body are:\n ", "operationId":"event::Policies::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/eventPolicies", "required":[ "PolicyName", "PolicyZoneID", "PolicyProcessType", "PolicyPollTime", "PolicyNodeID", "PolicyStatusID" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new CAPE policy.", "type":"array", "items":{ "$ref":"#/components/schemas/eventPoliciesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Policies-post", "x-filename-id":"api-event-policies-post" } }, "/api/event/Policies/readForSelect":{ "get":{ "tags":[ "Event/CAPE Policies" ], "summary":"Get CAPE Policies for Combo Boxes and Item Selectors", "description":"Gets CAPE policies in a format suitable for combo boxes and item selectors.", "operationId":"event::Policies::readForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "message":{ "example":"Loaded 3 entries" }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"3" }, "data":{ "description":"The list of CAPE policies.", "type":"array", "items":{ "$ref":"#/components/schemas/eventPoliciesReadForSelect" }, "example":[ { "PolicyID":"1", "PolicyName":"AbnormalActivity" }, { "PolicyID":"3", "PolicyName":"FaultStormsDips" }, { "PolicyID":"2", "PolicyName":"OperationPerformance" } ] } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Policies-readForSelect-get", "x-filename-id":"api-event-policies-readforselect-get" } }, "/api/event/SupervisedCorrelations/{id}":{ "get":{ "tags":[ "Event/Supervised Correlations" ], "summary":"Get an Event Supervised Correlation Policy by ID", "description":"Gets the event supervised correlation policy that matches the specified ID.", "operationId":"event::SupervisedCorrelations::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The event supervised correlation policy ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/eventSupervisedCorrelationsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-SupervisedCorrelations-{id}-get", "x-filename-id":"api-event-supervisedcorrelations-id-get" }, "put":{ "tags":[ "Event/Supervised Correlations" ], "summary":"Update an Event Supervised Correlation Policy", "description":"Updates the properties of the event supervised correlation policy that matches the specified ID.
The minimum required properties in the request body are:\n \nYou must also include properties for the field set in MatchFields as <Field> and <Field>Root. For example, if you set the value of MatchFields to [\"Ack\"], you must also include AckRoot and Ack.", "operationId":"event::SupervisedCorrelations::update", "parameters":[ { "name":"id", "in":"path", "description":"The event supervised correlation policy ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/eventSupervisedCorrelations" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the updated event supervised correlation policy.", "type":"array", "items":{ "$ref":"#/components/schemas/eventSupervisedCorrelationsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-SupervisedCorrelations-{id}-put", "x-filename-id":"api-event-supervisedcorrelations-id-put" }, "delete":{ "tags":[ "Event/Supervised Correlations" ], "summary":"Delete an Event Supervised Correlation Policy", "description":"Deletes the event supervised correlation policy that matches the specified ID.", "operationId":"event::SupervisedCorrelations::delete", "parameters":[ { "name":"id", "in":"path", "description":"The event supervised correlation policy ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-SupervisedCorrelations-{id}-delete", "x-filename-id":"api-event-supervisedcorrelations-id-delete" } }, "/api/event/SupervisedCorrelations/":{ "get":{ "tags":[ "Event/Supervised Correlations" ], "summary":"Get Event Supervised Correlation Policies", "description":"Gets the event supervised correlation policies that match the specified parameters. If no parameters are specified, all supervised correlation policies are returned.", "operationId":"event::SupervisedCorrelations::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of event supervised correlation properties that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/eventSupervisedCorrelationsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-SupervisedCorrelations--get", "x-filename-id":"api-event-supervisedcorrelations-get" }, "post":{ "tags":[ "Event/Supervised Correlations" ], "summary":"Create an Event Supervised Correlation Policy", "description":"Creates a new event supervised correlation policy.
The minimum required properties in the request body are:\n \nYou must also include properties for the field set in MatchFields as <Field> and <Field>Root. For example, if you set the value of MatchFields to [\"Ack\"], you must also include AckRoot and Ack.", "operationId":"event::SupervisedCorrelations::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/eventSupervisedCorrelations", "required":[ "SupervisedCorrelationName", "MatchFields", "MetaEventID", "GroupByFields", "MinimumMembers", "TimeWindow" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new event supervised correlation policy.", "type":"array", "items":{ "$ref":"#/components/schemas/eventSupervisedCorrelationsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-SupervisedCorrelations--post", "x-filename-id":"api-event-supervisedcorrelations-post" } }, "/api/event/SupervisedCorrelations/readKeysForSelect":{ "get":{ "tags":[ "Event/Supervised Correlations" ], "summary":"Get Event Keys for Combo Boxes and Item Selectors", "description":"Gets the list of unique event keys from the Events table in a format suitable for combo boxes and item selectors.", "operationId":"event::SupervisedCorrelations::readKeysForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/query" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"2" }, "data":{ "description":"The list of event keys.", "type":"array", "items":{ "type":"object", "properties":{ "EventKey":{ "description":"The event key from the Events table.", "type":"string" } } }, "example":[ { "EventKey":"Service_Primary Database Shard 1" }, { "EventKey":"Service_Redundant Database Shard 2" } ] } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-SupervisedCorrelations-readKeysForSelect-get", "x-filename-id":"api-event-supervisedcorrelations-readkeysforselect-get" } }, "/api/event/Tools/{id}":{ "get":{ "tags":[ "Event/Event Tools" ], "summary":"Get an Event Tool by ID", "description":"Gets the event tool that matches the specified ID.", "operationId":"event::Tools::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The event tool ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/eventToolsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Tools-{id}-get", "x-filename-id":"api-event-tools-id-get" }, "put":{ "tags":[ "Event/Event Tools" ], "summary":"Update an Event Tool", "description":"Updates the properties of the event tool that matches the specified ID.", "operationId":"event::Tools::update", "parameters":[ { "name":"id", "in":"path", "description":"The event tool ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/eventTools" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/eventToolsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Tools-{id}-put", "x-filename-id":"api-event-tools-id-put" }, "delete":{ "tags":[ "Event/Event Tools" ], "summary":"Delete an Event Tool", "description":"Deletes the event tool that matches the specified ID.", "operationId":"event::Tools::delete", "parameters":[ { "name":"id", "in":"path", "description":"The event tool ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Tools-{id}-delete", "x-filename-id":"api-event-tools-id-delete" } }, "/api/event/Tools/":{ "get":{ "tags":[ "Event/Event Tools" ], "summary":"Get Event Tools", "description":"Gets the event tools that match the specified parameters. If no parameters are specified, all event tools are returned.", "operationId":"event::Tools::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of event tools that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/eventToolsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Tools--get", "x-filename-id":"api-event-tools-get" }, "post":{ "tags":[ "Event/Event Tools" ], "summary":"Create an Event Tool", "description":"Creates a new event tool.
When ToolTypeID is 1 (for View tools), the minimum required properties in the request body are:\n \n
When ToolTypeID is 2 (for SQL tools), the minimum required properties in the request body are:\n ", "operationId":"event::Tools::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/eventTools", "required":[ "ToolName", "Icon", "ToolPath", "ToolPathTypeID", "ToolTarget", "Refresh", "AugmentData", "ToolTypeID" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new event tool.", "type":"array", "items":{ "$ref":"#/components/schemas/eventToolsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Tools--post", "x-filename-id":"api-event-tools-post" } }, "/api/event/Tools/readForSelect":{ "get":{ "tags":[ "Event/Event Tools" ], "summary":"Get Event Tools for Combo Boxes and Item Selectors", "description":"Gets event tools in a format suitable for combo boxes and item selectors.", "operationId":"event::Tools::readForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/query" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of event tools.", "type":"array", "items":{ "type":"object", "properties":{ "ToolID":{ "description":"The event tool ID.", "type":"integer", "example":"1" }, "ToolName":{ "description":"The event tool name.", "type":"string", "example":"Acknowledge" } } } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-Tools-readForSelect-get", "x-filename-id":"api-event-tools-readforselect-get" } }, "/api/event/WatcherPolicies/{id}":{ "get":{ "tags":[ "Event/Watcher Policies" ], "summary":"Get an Event Watcher Policy by ID", "description":"Gets the event watcher policy that matches the specified ID.", "operationId":"event::WatcherPolicies::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The event watcher policy ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-WatcherPolicies-{id}-get", "x-filename-id":"api-event-watcherpolicies-id-get" }, "put":{ "tags":[ "Event/Watcher Policies" ], "summary":"Update an Event Watcher Policy", "description":"Updates the event watcher policy that matches the specified ID.\n
Because event watcher policies are stored in the database with a specific user ID, and externally-authenticated transient users do not have Unified Assurance user IDs, transient users cannot update event watcher policies.", "operationId":"event::WatcherPolicies::update", "parameters":[ { "name":"id", "in":"path", "description":"The event watcher policy ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/eventWatcherPoliciesUpdate" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the updated event watcher policy.", "type":"array", "items":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-WatcherPolicies-{id}-put", "x-filename-id":"api-event-watcherpolicies-id-put" }, "delete":{ "tags":[ "Event/Watcher Policies" ], "summary":"Delete an Event Watcher Policy", "description":"Deletes the event watcher policy that matches the specified ID.", "operationId":"event::WatcherPolicies::delete", "parameters":[ { "name":"id", "in":"path", "description":"The event watcher policy ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-WatcherPolicies-{id}-delete", "x-filename-id":"api-event-watcherpolicies-id-delete" } }, "/api/event/WatcherPolicies":{ "get":{ "tags":[ "Event/Watcher Policies" ], "summary":"Get Event Watcher Policies", "description":"Gets the event watcher policies that match the specified parameters. If no parameters are specified, all event watcher policies are returned.", "operationId":"event::WatcherPolicies::Read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of event watcher policies that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-WatcherPolicies-get", "x-filename-id":"api-event-watcherpolicies-get" }, "post":{ "tags":[ "Event/Watcher Policies" ], "summary":"Create an Event Watcher Policy", "description":"Creates a new event watcher policy.\n
Because event watcher policies are stored in the database with a specific user ID, and externally-authenticated transient users do not have Unified Assurance user IDs, transient users cannot create event watcher policies.\n
The minimum required properties in the request body are:\n ", "operationId":"event::WatcherPolicies::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/eventWatcherPolicies", "required":[ "PolicyName", "PolicyDescription", "PolicyPollTime", "PolicyStatusID", "PolicyThresholdMetric", "PolicyThresholdField", "PolicyThresholdOperatorID", "PolicyThresholdValue", "ActionType", "PolicyEventID", "SearchType", "PolicyGrouping" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new event watcher policy.", "type":"array", "items":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-WatcherPolicies-post", "x-filename-id":"api-event-watcherpolicies-post" } }, "/api/event/WatcherPolicies/readForSelect":{ "get":{ "tags":[ "Event/Watcher Policies" ], "summary":"Get Event Watcher Policies for Combo Boxes and Item Selectors", "description":"Gets event watcher policies in a format suitable for combo boxes and item selectors.", "operationId":"event::WatcherPolicies::readForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/query" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of event watcher policies.", "type":"array", "items":{ "$ref":"#/components/schemas/eventWatcherPoliciesReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-WatcherPolicies-readForSelect-get", "x-filename-id":"api-event-watcherpolicies-readforselect-get" } }, "/api/event/WatcherPolicies/readFieldsForSelect":{ "get":{ "tags":[ "Event/Watcher Policies" ], "summary":"Get Events Table Fields", "description":"This method is deprecated. Use API/event/Events/readFields.", "operationId":"event::WatcherPolicies::readFieldsForSelect", "deprecated":true, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The Events table fields.", "type":"array", "items":{ "$ref":"#/components/schemas/eventWatcherPoliciesReadFieldsForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-event-WatcherPolicies-readFieldsForSelect-get", "x-filename-id":"api-event-watcherpolicies-readfieldsforselect-get" } }, "/api/eventNavigation/Events/readForTree":{ "get":{ "tags":[ "Event/Event Navigation" ], "summary":"Get Event Filters under a Specific Node", "description":"Gets event filter groups in a format suitable for tree grids.", "operationId":"eventNavigation::Events::readForTree", "parameters":[ { "name":"node", "description":"The node ID in event filter group tree. The ID value can be special values such as root (Global folder), private (Private Filters folder), meta (MetaTags folder) or event filter group ID.", "in":"query", "required":true, "schema":{ "type":"string" }, "example":"root" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of event filter groups.", "type":"array", "items":{ "type":"object", "properties":{ "id":{ "description":"The unique identifier for the filter.", "type":"string", "example":"Filter-1-7" }, "text":{ "description":"The display text for the filter.", "type":"string", "example":"Acked Events" }, "viewTitle":{ "description":"The title to display in the view.", "type":"string", "example":"Acked Events" }, "leaf":{ "description":"Indicates whether this is a leaf node in a hierarchy.", "type":"boolean", "example":true }, "iconCls":{ "description":"The CSS class for the filter icon.", "type":"string", "example":"icon-filter" }, "view":{ "description":"The URL or path for navigating to this filter.", "type":"string", "example":"#events?FilterType=FilterID&FilterValue=7&DisplayID=1&FilterGroupID=1&viewTitle=Acked%20Events" } } }, "example":[ { "text":"Private Filters", "id":"private", "expanded":false }, { "text":"Filters by Group: Global", "id":"1", "expanded":false, "viewTitle":"Global" }, { "text":"Filters by MetaTags", "id":"meta", "expanded":false }, { "id":"Filter-1-7", "text":"Acked Events", "viewTitle":"Acked Events", "leaf":true, "iconCls":"icon-filter", "view":"#events?FilterType=FilterID&FilterValue=7&DisplayID=1&FilterGroupID=1&viewTitle=Acked%20Events" } ] } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-eventNavigation-Events-readForTree-get", "x-filename-id":"api-eventnavigation-events-readfortree-get" } }, "/api/eventNavigation/Events/readStates":{ "get":{ "tags":[ "Event/Event Navigation" ], "summary":"Get Severity States and Summary Count of Event Filters", "description":"Gets the severity states and the summary count of event filters.", "operationId":"eventNavigation::Events::readStates", "parameters":[ { "name":"id", "description":"The comma-separated list of event filter IDs.", "in":"query", "required":true, "schema":{ "type":"string", "example":"private,1,Filter-1-7,Filter-1-23" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of event filters with their severity states and summary count.", "type":"array", "items":{ "type":"object", "properties":{ "id":{ "description":"The event filter ID.", "type":"string" }, "EventSeverity":{ "description":"The highest severity value among the filtered events.", "type":"string", "example":"normal" }, "Count":{ "description":"The number of unique events (ie Rows).", "type":"integer", "example":0 }, "SumCount":{ "description":"The sum of count is the total count, SUM(Count),of all events. Each event can be deduplicated and the count for each one can be more than 1. Sum includes everything. For example, for a device with 2 events, the first with a count of 1 and the second with a count of 9; the Count is 2, and the SumOfCount is 10.", "type":"integer", "example":0 }, "SeverityValues":{ "description":"The array of event severity counts in the order from Normal to Critical.\nThe order of severity in the list is: Normal, Unknown, Info, Minor, Major, Critical.", "type":"array", "items":{ "type":"integer" }, "example":[ 0, 0, 0, 0, 0 ] }, "LoadingStates":{ "description":"Loading States", "type":"boolean", "example":false } } }, "example":[ { "id":"Filter-1-7", "EventSeverity":"normal", "Count":0, "SumCount":0, "SeverityValues":[ 0, 0, 0, 0, 0, 0 ], "LoadingStates":false, "raw":{ "success":true, "message":"Loaded 0 entries", "data":[ ], "errors":null, "total":0, "warnings":null, "metaData":{ "root":"data", "fields":[ ], "columns":[ ], "severities":{ "normal":0, "unknown":0, "info":0, "minor":0, "major":0, "critical":0, "all":0, "sum":0 } } } }, { "id":"Filter-1-23", "EventSeverity":"critical", "Count":2562, "SumCount":3577998, "SeverityValues":[ 2, 0, 1, 1589, 809, 161 ], "LoadingStates":false, "raw":{ "success":true, "message":"Loaded 0 entries", "data":[ ], "errors":null, "total":0, "warnings":null, "metaData":{ "root":"data", "fields":[ ], "columns":[ ], "severities":{ "normal":0, "unknown":0, "info":0, "minor":0, "major":102, "critical":147, "all":249, "sum":700295 } } } } ] } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-eventNavigation-Events-readStates-get", "x-filename-id":"api-eventnavigation-events-readstates-get" } }, "/api/file/Files/{id}":{ "get":{ "tags":[ "File/Files" ], "summary":"Get a File by ID", "description":"Gets the file that matches the specified ID.", "operationId":"file::File::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The file ID specified for individual CRUD operations.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/fileFilesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-file-Files-{id}-get", "x-filename-id":"api-file-files-id-get" }, "put":{ "tags":[ "File/Files" ], "summary":"Update a File", "description":"Updates the file in Unified Assurance file storage that matches the specified ID.", "operationId":"file::Files::update", "parameters":[ { "name":"id", "in":"path", "description":"The file ID specified for individual CRUD operations.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/fileFiles" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/fileFileTypesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-file-Files-{id}-put", "x-filename-id":"api-file-files-id-put" }, "delete":{ "tags":[ "File/Files" ], "summary":"Delete a File", "description":"Deletes the file that matches the specified ID.", "operationId":"file::Files::delete", "parameters":[ { "name":"id", "in":"path", "description":"The file ID specified for individual CRUD operations.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-file-Files-{id}-delete", "x-filename-id":"api-file-files-id-delete" } }, "/api/file/Files":{ "get":{ "tags":[ "File/Files" ], "summary":"Get Files", "description":"Gets the files that match the specified parameters. If no parameters are specified, all files are returned.", "operationId":"file::Files::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of files that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/fileFilesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-file-Files-get", "x-filename-id":"api-file-files-get" }, "post":{ "tags":[ "File/Files" ], "summary":"Upload a File", "description":"Uploads a new file in the Unified Assurance file storage.
The minimum required properties in the request body are:\n ", "operationId":"file::Files::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/fileFiles" } ], "required":[ "FileTypeID", "ExpireTime", "OwnerUserID", "OwnerUserGroupID", "UploadFile" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new file.", "type":"array", "items":{ "$ref":"#/components/schemas/fileFilesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-file-Files-post", "x-filename-id":"api-file-files-post" } }, "/api/file/Files/readForSelect":{ "get":{ "tags":[ "File/Files" ], "summary":"Get Files for Combo Boxes and Item Selectors", "description":"Gets files in a format suitable for combo boxes and item selectors.", "operationId":"file::Files::readForSelect", "parameters":[ { "name":"FileTypeID", "description":"The unique identifier for the file type. It filters the results by file type.
\nAllowed Values:\n", "in":"query", "required":false, "schema":{ "type":"integer" } }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "name":"query", "in":"query", "description":"The query search string. It searches by the matching file name.", "required":false, "schema":{ "type":"string" } }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of files.", "type":"array", "items":{ "$ref":"#/components/schemas/fileFilesReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-file-Files-readForSelect-get", "x-filename-id":"api-file-files-readforselect-get" } }, "/api/file/Files/readContent":{ "get":{ "tags":[ "File/Files" ], "summary":"Return a File Based on ID or File Name", "description":"Returns the file content based on the file ID or the file name.", "operationId":"file::Files::readContent", "parameters":[ { "name":"id", "description":"The file ID used for fetching the content.", "in":"query", "required":false, "schema":{ "type":"integer", "example":1021 } }, { "name":"FileName", "description":"The file name used for fetching the content.", "in":"query", "required":true, "schema":{ "type":"string", "example":"Test.pdf" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/pdf":{ "schema":{ "type":"string", "format":"binary" } } } }, "404":{ "description":"File not found." }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-file-Files-readContent-get", "x-filename-id":"api-file-files-readcontent-get" } }, "/api/file/Files/executeDownload/{id}":{ "get":{ "tags":[ "File/Files" ], "summary":"Download a File", "description":"Downloads the file.", "operationId":"file::Files::executeDownload", "parameters":[ { "name":"id", "description":"The file ID used to download the file.", "in":"path", "required":true, "schema":{ "type":"integer", "example":1021 } }, { "name":"FileName", "description":"The file name used for downloading the file instead of ID.", "in":"query", "required":false, "schema":{ "type":"string", "example":"Test.pdf" } }, { "name":"MimeType", "description":"Mime Type", "in":"query", "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/pdf":{ "schema":{ "type":"string", "format":"binary" } } } }, "404":{ "description":"File not found." }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-file-Files-executeDownload-{id}-get", "x-filename-id":"api-file-files-executedownload-id-get" } }, "/api/file/FileTypes/{id}":{ "get":{ "tags":[ "File/File Types" ], "summary":"Get a File Type by ID", "description":"Gets the file type that matches the specified ID.", "operationId":"file::FileTypes::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The file type ID specified for individual CRUD operations.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "description":"The file type that matches the specified ID.", "items":{ "$ref":"#/components/schemas/fileFileTypesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-file-FileTypes-{id}-get", "x-filename-id":"api-file-filetypes-id-get" }, "put":{ "tags":[ "File/File Types" ], "summary":"Update a File Type", "description":"Updates the file type that matches the specified ID.", "operationId":"file::FileTypes::update", "parameters":[ { "name":"id", "in":"path", "description":"The file type ID specified for individual CRUD operations.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/fileFileTypes" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/fileFileTypesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-file-FileTypes-{id}-put", "x-filename-id":"api-file-filetypes-id-put" }, "delete":{ "tags":[ "File/File Types" ], "summary":"Delete a File Type", "description":"Deletes the file type that matches the specified ID.", "operationId":"file::fileTypes::delete", "parameters":[ { "name":"id", "in":"path", "description":"The file type ID specified for individual CRUD operations.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-file-FileTypes-{id}-delete", "x-filename-id":"api-file-filetypes-id-delete" } }, "/api/file/FileTypes":{ "get":{ "tags":[ "File/File Types" ], "summary":"Get File Types", "description":"Gets the file types that match the specified parameters. If no parameters are specified, all file types are returned.", "operationId":"file::FileTypes::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of file types that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/fileFileTypesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-file-FileTypes-get", "x-filename-id":"api-file-filetypes-get" }, "post":{ "tags":[ "File/File Types" ], "summary":"Add a File Type", "description":"Adds a file type. At minimum, the FileTypeName property is required in the request body.", "operationId":"file::FileTypes::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/fileFileTypes", "required":[ "FieldTypeName" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new file type.", "type":"array", "items":{ "$ref":"#/components/schemas/fileFileTypesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-file-FileTypes-post", "x-filename-id":"api-file-filetypes-post" } }, "/api/file/FileTypes/readForSelect":{ "get":{ "tags":[ "File/File Types" ], "summary":"Get File Types for Combo Boxes and Item Selectors", "description":"Gets file types in a format suitable for combo boxes and item selectors.", "operationId":"file::FileTypes::readForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "name":"query", "in":"query", "description":"The query search string. It filters the results by file type name.", "required":false, "schema":{ "type":"string" } }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of file types.", "type":"array", "items":{ "$ref":"#/components/schemas/fileFileTypesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-file-FileTypes-readForSelect-get", "x-filename-id":"api-file-filetypes-readforselect-get" } }, "/api/gateway/Gateways/{id}":{ "get":{ "tags":[ "Gateway/Gateways" ], "summary":"Get Gateway Objects by ID", "description":"Gets the gateway objects that matches the specified ID.", "operationId":"gateway::Gateways:Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The gateway object ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/gatewayGatewaysRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-gateway-Gateways-{id}-get", "x-filename-id":"api-gateway-gateways-id-get" }, "put":{ "tags":[ "Gateway/Gateways" ], "summary":"Update a Gateway Vertex", "description":"Updates an existing gateway vertex identified by gateway object ID.\nThis method allows you to make changes to the properties of a gateway vertex.\n", "operationId":"gateway::Gateways::update", "parameters":[ { "name":"id", "in":"path", "description":"The gateway object ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" }, { "name":"DeviceName", "in":"query", "description":"If DeviceID is not provided, then the user has to provide DeviceName.", "required":false, "schema":{ "type":"string" } }, { "name":"DeviceZoneID", "in":"query", "description":"The device zone ID. If DeviceID is not provided, then the user has to provide DeviceZoneID.", "required":false, "schema":{ "type":"integer" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/gatewayGateways" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/gatewayGatewaysRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-gateway-Gateways-{id}-put", "x-filename-id":"api-gateway-gateways-id-put" }, "delete":{ "tags":[ "Gateway/Gateways" ], "summary":"Delete a Gateway Vertex", "description":"Deletes a Gateway Vertex identified by Gateway Object ID.", "operationId":"gateway::Gateways::delete", "parameters":[ { "name":"id", "in":"path", "description":"The gateway object ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-gateway-Gateways-{id}-delete", "x-filename-id":"api-gateway-gateways-id-delete" } }, "/api/gateway/Gateways":{ "get":{ "tags":[ "Gateway/Gateways" ], "summary":"Get Gateway Objects", "description":"Gets the attributes of gateway objects that match the specified parameters. If no parameters are specified, all gateway objects along with their attributes are returned.", "operationId":"gateway::Gateways:read", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/gatewayGatewaysRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-gateway-Gateways-get", "x-filename-id":"api-gateway-gateways-get" }, "post":{ "tags":[ "Gateway/Gateways" ], "summary":"Create a Gateway Vertex", "description":"Creates a new gateway vertex.
The minimum required properties in the request body are:\n ", "operationId":"gateway::Gateways:create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/gatewayGateways", "required":[ "Port", "DeviceName", "ConnectionTypeID", "StatusID", "Elements" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/gatewayGatewaysRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-gateway-Gateways-post", "x-filename-id":"api-gateway-gateways-post" } }, "/api/gateway/Gateways/readForSelect":{ "get":{ "tags":[ "Gateway/Gateways" ], "summary":"Get Gateway Vertices for Combo Boxes and Item Selectors", "description":"Gets gateway vertices in a format suitable for combo boxes and item selectors.", "operationId":"gateway::Gateways::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/gatewayGatewaysReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-gateway-Gateways-readForSelect-get", "x-filename-id":"api-gateway-gateways-readforselect-get" } }, "/api/gateway/Elements/{id}":{ "get":{ "tags":[ "Gateway/Gateway Elements" ], "summary":"Get an Element by ID", "description":"Gets the element that matches the specified ID.", "operationId":"gateway::Elements:Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The element object ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/gatewayElementsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-gateway-Elements-{id}-get", "x-filename-id":"api-gateway-elements-id-get" }, "put":{ "tags":[ "Gateway/Gateway Elements" ], "summary":"Update an Element Vertex", "description":"Updates an existing element vertex identified by element object ID.\nThis method allows you to make changes to the properties of an element vertex.\n", "operationId":"gateway::Elements::update", "parameters":[ { "name":"id", "in":"path", "description":"The element Object ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/gatewayElements" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/gatewayElementsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-gateway-Elements-{id}-put", "x-filename-id":"api-gateway-elements-id-put" }, "delete":{ "tags":[ "Gateway/Gateway Elements" ], "summary":"Delete an Element Vertex", "description":"Deletes an element vertex identified by element object ID.", "operationId":"gateway::Elements::delete", "parameters":[ { "name":"id", "in":"path", "description":"The element object ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-gateway-Elements-{id}-delete", "x-filename-id":"api-gateway-elements-id-delete" } }, "/api/gateway/Elements":{ "get":{ "tags":[ "Gateway/Gateway Elements" ], "summary":"Get Element Objects", "description":"Gets the attributes of element objects that match the specified parameters. If no parameters are specified, all element objects along with their attributes are returned.", "operationId":"gateway::Elements:read", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/gatewayElementsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-gateway-Elements-get", "x-filename-id":"api-gateway-elements-get" }, "post":{ "tags":[ "Gateway/Gateway Elements" ], "summary":"Create an Element Vertex", "description":"Creates a new element vertex.
The minimum required properties in the request body are:\n ", "operationId":"gateway::Elements:create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/gatewayElements", "required":[ "ElementName", "GatewayID", "CTAG", "LoginCommand", "LogoutCommand", "Commands", "PollTimer" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/gatewayElementsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-gateway-Elements-post", "x-filename-id":"api-gateway-elements-post" } }, "/api/gateway/Elements/readForSelect":{ "get":{ "tags":[ "Gateway/Gateway Elements" ], "summary":"Get Element Vertices for Combo Boxes and Item Selectors", "description":"Gets element vertices in a format suitable for combo boxes and item selectors.", "operationId":"gateway::Elements::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/gatewayElementsReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-gateway-Elements-readForSelect-get", "x-filename-id":"api-gateway-elements-readforselect-get" } }, "/api/graph/Graphs/read":{ "get":{ "tags":[ "Graph/Graphs" ], "summary":"Get Topology Vertices and Edges", "description":"Gets the topology vertices and edges that match the specified query parameters.", "operationId":"graph::Graphs::read", "parameters":[ { "name":"GraphType", "in":"query", "description":"The graph type. \nPossible values are: \n", "required":true, "schema":{ "type":"string", "example":"VertexList" } }, { "name":"ViewEdgeTypes", "in":"query", "description":"The list of edge types to get. Use Any to get all edge types.", "required":false, "schema":{ "type":"string", "example":"Any" } }, { "name":"ViewVertexTypes", "in":"query", "description":"The list of vertex types to get. Use Any to get all vertex types.", "required":false, "schema":{ "type":"array", "items":{ }, "example":"Any" } }, { "name":"StartVertexID", "in":"query", "description":"The start vertex ID.", "required":false, "schema":{ "type":"string", "example":"b1e9b165-5f05-4e41-8031-e9f7586a88f9" } }, { "name":"StartVertexName", "in":"query", "description":"The start vertex name.", "required":false, "schema":{ "type":"string", "example":"router.example.com" } }, { "name":"EndVertexID", "in":"query", "description":"The end vertex ID.", "required":false, "schema":{ "type":"string" }, "example":"b1e9b185-5f05-4e41-8031-e9f7586a88f9" }, { "name":"EndVertexName", "in":"query", "description":"The end vertex name.", "required":false, "schema":{ "type":"string" }, "example":"vertex.example.com" }, { "name":"VertexGroupByTypeName", "in":"query", "description":"The group by vertex type name.", "required":false, "schema":{ "anyOf":[ { "type":"array" }, { "type":"string" } ] }, "example":"Any" }, { "name":"VertexTuckAwayTypeName", "in":"query", "description":"The tuck away vertex type name.", "required":false, "schema":{ "anyOf":[ { "type":"array" }, { "type":"string" } ] }, "example":"Interface" }, { "name":"Hops", "in":"query", "description":"The number of hops (links) to follow.", "required":false, "schema":{ "type":"integer", "format":"int32" }, "example":1 }, { "name":"StartVertexPath", "in":"query", "description":"The path to the start vertex.", "schema":{ "type":"string", "example":"//Root//Self Monitoring (Manual Thresholds)" } }, { "name":"Layout", "in":"query", "description":"The layout type.", "schema":{ "type":"string", "example":"Tree" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/graphGraphsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-Graphs-read-get", "x-filename-id":"api-graph-graphs-read-get" } }, "/api/graph/Graphs/readForDirectionalTree":{ "get":{ "tags":[ "Graph/Graphs" ], "summary":"Get Topology Vertices and Edges in a Hierarchical Array", "description":"Gets topology vertices and edges in a hierarchical array.", "operationId":"graph::Graphs::readForDirectionalTree", "parameters":[ { "name":"StartVertexPath", "in":"query", "description":"The path to the start vertex.", "schema":{ "type":"string", "example":"//Root//Self Monitoring (Manual Thresholds)" } }, { "name":"Hops", "in":"query", "description":"The number of hops (links) to follow.", "required":false, "schema":{ "type":"integer", "format":"int32" }, "example":1 }, { "name":"StartVertexID", "in":"query", "description":"The start vertex ID.", "required":false, "schema":{ "type":"string", "example":"b1e9b165-5f05-4e41-8031-e9f7586a88f9" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/graphGraphsReadForDirectionalTree" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-Graphs-readForDirectionalTree-get", "x-filename-id":"api-graph-graphs-readfordirectionaltree-get" } }, "/api/graph/Edges/{id}":{ "get":{ "tags":[ "Graph/Edges" ], "summary":"Get an Edge by ID", "description":"Gets the edge that matches the specified ID.", "operationId":"graph::Edges::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The edge ID.", "required":true, "schema":{ "type":"string", "example":2 } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/graphEdgesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-Edges-{id}-get", "x-filename-id":"api-graph-edges-id-get" }, "put":{ "tags":[ "Graph/Edges" ], "summary":"Update an Edge", "description":"Updates the properties of the edge that matches the specified ID.", "operationId":"graph::Edges::update", "parameters":[ { "name":"id", "in":"path", "description":"The edge ID.", "required":true, "schema":{ "type":"string" }, "example":1 } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/graphEdgesPut" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/graphEdgesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-Edges-{id}-put", "x-filename-id":"api-graph-edges-id-put" }, "delete":{ "tags":[ "Graph/Edges" ], "summary":"Delete an Edge", "description":"Deletes the edge that matches the specified ID.", "operationId":"graph::Edges::delete", "parameters":[ { "name":"id", "in":"path", "description":"The edge ID.", "required":true, "schema":{ "type":"string" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-Edges-{id}-delete", "x-filename-id":"api-graph-edges-id-delete" } }, "/api/graph/Edges":{ "get":{ "tags":[ "Graph/Edges" ], "summary":"Get Edges", "description":"Gets the edges that match the specified parameters. If no parameters are specified, all edges are returned.", "operationId":"graph::Edges::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/graphEdgesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-Edges-get", "x-filename-id":"api-graph-edges-get" }, "post":{ "tags":[ "Graph/Edges" ], "summary":"Create an Edge", "description":"Creates a new edge.
The minimum required properties in the request body are:\n ", "operationId":"graph::Edges::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/graphEdges", "required":[ "OutVertexID", "InVertexID", "EdgeTypeID", "EdgeProps" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/graphEdgesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-Edges-post", "x-filename-id":"api-graph-edges-post" } }, "/api/graph/Edges/readProperties":{ "get":{ "tags":[ "Graph/Edges" ], "summary":"Get Property Values by Edge Type and Property", "description":"Gets values for properties that match the specified edge type and property.", "operationId":"graph::Edges::readProperties", "parameters":[ { "name":"Property", "in":"query", "description":"The property.", "schema":{ "anyOf":[ { "type":"string" }, { "type":"array" } ] }, "example":"XYZ Corp" }, { "name":"EdgeType", "in":"query", "description":"The edge type.", "schema":{ "anyOf":[ { "type":"string" }, { "type":"array" } ] }, "example":"ConnectsLayer1" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/graphVerticesReadProperties" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-Edges-readProperties-get", "x-filename-id":"api-graph-edges-readproperties-get" } }, "/api/graph/EdgeTypes/{id}":{ "get":{ "tags":[ "Graph/Edge Types" ], "summary":"Get an Edge Type by ID", "description":"Gets the edge type that matches the specified ID.", "operationId":"graph::EdgeTypes::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The edge type ID.", "required":true, "schema":{ "type":"integer", "format":"int32", "example":2 } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/graphEdgeTypesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-EdgeTypes-{id}-get", "x-filename-id":"api-graph-edgetypes-id-get" }, "put":{ "tags":[ "Graph/Edge Types" ], "summary":"Update an Edge Type", "description":"Updates the properties of the edge type that matches the specified ID.", "operationId":"graph::EdgeTypes::update", "parameters":[ { "name":"id", "in":"path", "description":"The edge type ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/graphEdgeTypes" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/graphEdgeTypesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-EdgeTypes-{id}-put", "x-filename-id":"api-graph-edgetypes-id-put" }, "delete":{ "tags":[ "Graph/Edge Types" ], "summary":"Delete an Edge Type", "description":"Deletes the edge type that matches the specified ID.", "operationId":"graph::EdgeTypes::delete", "parameters":[ { "name":"id", "in":"path", "description":"The edge type ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-EdgeTypes-{id}-delete", "x-filename-id":"api-graph-edgetypes-id-delete" } }, "/api/graph/EdgeTypes":{ "get":{ "tags":[ "Graph/Edge Types" ], "summary":"Get Edge Types", "description":"Gets the edge types that match the specified parameters. If no parameters are specified, all edge types are returned.", "operationId":"graph::EdgeTypes::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/graphEdgeTypesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-EdgeTypes-get", "x-filename-id":"api-graph-edgetypes-get" }, "post":{ "tags":[ "Graph/Edge Types" ], "summary":"Create an Edge Type", "description":"Creates an edge type.
The minimum required properties in the request body are:\n ", "operationId":"graph::EdgeTypes::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/graphEdgeTypes", "required":[ "EdgeTypeName", "LineTypeID", "Direction" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/graphEdgeTypesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-EdgeTypes-post", "x-filename-id":"api-graph-edgetypes-post" } }, "/api/graph/EdgeTypes/readForSelect":{ "get":{ "tags":[ "Graph/Edge Types" ], "summary":"Get Edge Types for Combo Boxes and Item Selectors", "description":"Gets edge types in a format suitable for combo boxes and item selectors.", "operationId":"graph::EdgeTypes::readForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/graphEdgeTypesreadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-EdgeTypes-readForSelect-get", "x-filename-id":"api-graph-edgetypes-readforselect-get" } }, "/api/graph/NodeDetails/read":{ "post":{ "tags":[ "Graph/Node Details" ], "summary":"Get the Status of a Topology Widget", "description":"Gets the status for the topology widget status that matches the specified vertex or edge class.", "operationId":"graph::NodeDetails::read", "requestBody":{ "content":{ "application/json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/graphNodeDetailsVertexClass" }, { "$ref":"#/components/schemas/graphNodeDetailsEdgeClass" } ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json-VertexClass":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/graphNodeDetailsReadVertexClass" } } } } ] } }, "application/json-EdgeClass":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/graphNodeDetailsReadEdgeClass" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-NodeDetails-read-post", "x-filename-id":"api-graph-nodedetails-read-post" } }, "/api/graph/PropertyTypes/{id}":{ "get":{ "tags":[ "Graph/Property Types" ], "summary":"Get a Property Type by ID", "description":"Gets the property type that matches the specified ID.", "operationId":"graph::PropertyTypes::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The property type ID, in id-PropertyName format.", "required":true, "schema":{ "type":"string" }, "example":"id-Customer" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/graphPropertyTypesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-PropertyTypes-{id}-get", "x-filename-id":"api-graph-propertytypes-id-get" }, "put":{ "tags":[ "Graph/Property Types" ], "summary":"Update a Property Type", "description":"Updates the properties of the property type that matches the specified ID.", "operationId":"graph::PropertyTypes::update", "parameters":[ { "name":"id", "in":"path", "description":"The property type ID, in id-PropertyName format.", "required":true, "schema":{ "type":"string" }, "example":"id-Customer" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/graphPropertyTypes" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/graphPropertyTypesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-PropertyTypes-{id}-put", "x-filename-id":"api-graph-propertytypes-id-put" }, "delete":{ "tags":[ "Graph/Property Types" ], "summary":"Delete a Property Type", "description":"Deletes the property type that matches the specified ID.", "operationId":"graph::PropertyTypes::delete", "parameters":[ { "name":"id", "in":"path", "description":"The property type ID, in id-PropertyName format.", "required":true, "schema":{ "type":"string" }, "example":"id-Customer" } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-PropertyTypes-{id}-delete", "x-filename-id":"api-graph-propertytypes-id-delete" } }, "/api/graph/PropertyTypes":{ "get":{ "tags":[ "Graph/Property Types" ], "summary":"Get Property Types", "description":"Gets the property types that match the specified parameters. If no parameters are specified, all property types are returned.", "operationId":"graph::PropertyTypes::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/graphPropertyTypesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-PropertyTypes-get", "x-filename-id":"api-graph-propertytypes-get" }, "post":{ "tags":[ "Graph/Property Types" ], "summary":"Create a Property Type", "description":"Creates a new property type.
The minimum required properties in the request body are:\n ", "operationId":"graph::PropertyTypes::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/graphPropertyTypes", "required":[ "PropertyName", "RenderType" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/graphPropertyTypesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-PropertyTypes-post", "x-filename-id":"api-graph-propertytypes-post" } }, "/api/graph/PropertyTypes/readForSelect":{ "get":{ "tags":[ "Graph/Property Types" ], "summary":"Get Objects for Combo Boxes and Item Selectors", "description":"Gets objects in a format suitable for combo boxes and item selectors.", "operationId":"graph::PropertyTypes::readForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/graphPropertyTypesReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-PropertyTypes-readForSelect-get", "x-filename-id":"api-graph-propertytypes-readforselect-get" } }, "/api/graph/VertexTypes/{id}":{ "get":{ "tags":[ "Graph/Vertex Types" ], "summary":"Get a Vertex Type by ID", "description":"Gets the vertex type that matches the specified ID.", "operationId":"graph::VertexTypes::ReadByID", "parameters":[ { "name":"id", "in":"path", "description":"The vertex type ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/graphVertexTypesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-VertexTypes-{id}-get", "x-filename-id":"api-graph-vertextypes-id-get" }, "put":{ "tags":[ "Graph/Vertex Types" ], "summary":"Update a Vertex Type", "description":"Updates the vertex type that matches the specified ID.", "operationId":"graph::VertexTypes::update", "parameters":[ { "name":"id", "in":"path", "description":"The vertex type ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/graphVertexTypes" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/graphVertexTypesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-VertexTypes-{id}-put", "x-filename-id":"api-graph-vertextypes-id-put" }, "delete":{ "tags":[ "Graph/Vertex Types" ], "summary":"Delete a Vertex Type", "description":"Deletes a Vertex Type identified by Vertex Type ID.", "operationId":"graph::VertexTypes::delete", "parameters":[ { "name":"id", "in":"path", "description":"The vertex type ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-VertexTypes-{id}-delete", "x-filename-id":"api-graph-vertextypes-id-delete" } }, "/api/graph/VertexTypes":{ "get":{ "tags":[ "Graph/Vertex Types" ], "summary":"Get Vertex Types", "description":"Gets the vertex types that match the specified parameters. If no parameters are specified, all vertex types are returned.", "operationId":"graph::VertexTypes::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/graphVertexTypesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-VertexTypes-get", "x-filename-id":"api-graph-vertextypes-get" }, "post":{ "tags":[ "Graph/Vertex Types" ], "summary":"Create a Vertex Type", "description":"Creates a new vertex type.
The minimum required properties in the request body are:\n ", "operationId":"graph::VertexTypes::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/graphVertexTypes", "required":[ "VertexTypeName", "Source", "VertexTypeIcon" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/graphVertexTypesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-VertexTypes-post", "x-filename-id":"api-graph-vertextypes-post" } }, "/api/graph/VertexTypes/readForSelect":{ "get":{ "tags":[ "Graph/Vertex Types" ], "summary":"Gets Objects for Combo Boxes and Item Selectors", "description":"Gets objects in a format suitable for combo boxes and item selectors.", "operationId":"graph::VertexTypes::readForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/graphVertexTypesReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-VertexTypes-readForSelect-get", "x-filename-id":"api-graph-vertextypes-readforselect-get" } }, "/api/graph/Vertices/{id}":{ "get":{ "tags":[ "Graph/Vertices" ], "summary":"Get a Vertex by ID", "description":"Gets the vertex that matches the specified ID.", "operationId":"graph::Vertices::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The vertex ID.", "required":true, "schema":{ "type":"string" }, "example":"1c730895-8505-43a9-ac8e-f18c75edcde9" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/graphVerticesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-Vertices-{id}-get", "x-filename-id":"api-graph-vertices-id-get" }, "put":{ "tags":[ "Graph/Vertices" ], "summary":"Update a Vertex", "description":"Updates the vertex that matches the specified ID.", "operationId":"graph::Vertices::update", "parameters":[ { "name":"id", "in":"path", "description":"The vertex ID.", "required":true, "schema":{ "type":"string" }, "example":"1c730895-8505-43a9-ac8e-f18c75edcde9" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/graphVerticesUpdate" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "allOf":[ { "$ref":"#/components/schemas/graphVerticesRead" }, { "type":"object", "properties":{ "CustomName":{ "type":"string", "description":"The custom name.", "example":"Name" } } } ] } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-Vertices-{id}-put", "x-filename-id":"api-graph-vertices-id-put" }, "delete":{ "tags":[ "Graph/Vertices" ], "summary":"Delete a Vertex", "description":"Deletes the vertex that matches the specified ID.", "operationId":"graph::Vertices::delete", "parameters":[ { "name":"id", "in":"path", "description":"The vertex ID.", "required":true, "schema":{ "type":"string" }, "example":"1c730895-8505-43a9-ac8e-f18c75edcde9" } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-Vertices-{id}-delete", "x-filename-id":"api-graph-vertices-id-delete" } }, "/api/graph/Vertices":{ "get":{ "tags":[ "Graph/Vertices" ], "summary":"Get Vertices", "description":"Gets the vertices that match the specified parameters. If no parameters are specified, all vertices are returned.", "operationId":"graph::Vertices::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/graphVerticesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-Vertices-get", "x-filename-id":"api-graph-vertices-get" }, "post":{ "tags":[ "Graph/Vertices" ], "summary":"Create a Vertex", "description":"Creates a new vertex.
The minimum required properties in the request body are:\n ", "operationId":"graph::Vertices::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/graphVertices", "required":[ "VertexName", "VertexTypeID", "VertexProps" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "allOf":[ { "$ref":"#/components/schemas/graphVerticesRead" }, { "type":"object", "properties":{ "CustomName":{ "type":"string", "description":"The custom name.", "example":"VertexName" } } } ] } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-Vertices-post", "x-filename-id":"api-graph-vertices-post" } }, "/api/graph/Vertices/readForSelect":{ "get":{ "tags":[ "Graph/Vertices" ], "summary":"Get Objects for Combo Boxes and Item Selectors", "description":"Gets objects in a format suitable for combo boxes and item selectors.", "operationId":"graph::Vertices::readForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/graphVerticesReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-Vertices-readForSelect-get", "x-filename-id":"api-graph-vertices-readforselect-get" } }, "/api/graph/Vertices/readProperties":{ "get":{ "tags":[ "Graph/Vertices" ], "summary":"Get Property Values by Vertex Type and Property", "description":"Gets the values for the property that matches the specified vertex type and property.", "operationId":"graph::Vertices::readProperties", "parameters":[ { "name":"Property", "in":"query", "description":"The property.", "schema":{ "anyOf":[ { "type":"string" }, { "type":"array" } ] }, "example":"XYZ Corp" }, { "name":"VertexType", "in":"query", "description":"The vertex type.", "schema":{ "anyOf":[ { "type":"string" }, { "type":"array" } ] }, "example":"Device" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/graphVerticesReadProperties" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-Vertices-readProperties-get", "x-filename-id":"api-graph-vertices-readproperties-get" } }, "/api/graph/Vertices/readDevicesForSelect":{ "get":{ "tags":[ "Graph/Vertices" ], "summary":"Get Device Vertices", "description":"Gets device vertices that match the specified query parameters.", "operationId":"graph::Vertices::readDevicesForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/graphVerticesReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-graph-Vertices-readDevicesForSelect-get", "x-filename-id":"api-graph-vertices-readdevicesforselect-get" } }, "/api/metric/Metrics/{id}":{ "get":{ "tags":[ "Metrics/Metrics" ], "summary":"Get a Metric by ID", "description":"Gets the metric that matches the specified ID.", "operationId":"metric::Metrics::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the metric to get.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricMetricsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Metrics-{id}-get", "x-filename-id":"api-metric-metrics-id-get" }, "put":{ "tags":[ "Metrics/Metrics" ], "summary":"Update a Metric", "description":"Updates the properties of the specified metric.", "operationId":"metric::Metrics::update", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the metric to update.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/metricMetrics" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricMetricsPut" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Metrics-{id}-put", "x-filename-id":"api-metric-metrics-id-put" }, "delete":{ "tags":[ "Metrics/Metrics" ], "summary":"Delete a Metric", "description":"Deletes the metric that matches the specified ID.", "operationId":"metric::Metrics::delete", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the metric to delete.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Metrics-{id}-delete", "x-filename-id":"api-metric-metrics-id-delete" } }, "/api/metric/Metrics":{ "get":{ "tags":[ "Metrics/Metrics" ], "summary":"Get Metrics", "description":"Gets the metrics that match the specified query parameters. If no parameters are specified, all metrics are returned. Oracle recommends using filtering and pagination parameters to limit the results.", "operationId":"metric::Metrics::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricMetricsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Metrics-get", "x-filename-id":"api-metric-metrics-get" }, "post":{ "tags":[ "Metrics/Metrics" ], "summary":"Create a Metric", "description":"Creates a new metric.
The minimum required properties in the request body are:\n ", "operationId":"metric::Metrics::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/metricMetrics", "required":[ "MetricTypeID", "InstanceID", "ShardID", "PollTime", "Factor", "MethodID", "StatusID", "Thresholds" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricMetricsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Metrics-post", "x-filename-id":"api-metric-metrics-post" } }, "/api/metric/Metrics/readForSelect":{ "get":{ "tags":[ "Metrics/Metrics" ], "summary":"Get Metrics for Combo Boxes and Item Selectors", "description":"Gets the metrics that match the specified query parameters in a format suitable for combo boxes and item selectors.
\nCaution: If you use this endpoint without filtering and pagination, it can impact database performance significantly and may require manual cleanup. You must use either the query or filter parameter, and Oracle also recommends using pagination parameters to limit the results.", "operationId":"metric::Metrics::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricMetricsReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Metrics-readForSelect-get", "x-filename-id":"api-metric-metrics-readforselect-get" } }, "/api/metric/Metrics/readForAllDevices":{ "get":{ "tags":[ "Metrics/Metrics" ], "summary":"Get Metrics for Real and Virtual Devices", "description":"Gets the metrics for real and virtual devices that match the specified query parameters. If no parameters are specified, all metrics are returned. Oracle recommends using filtering and pagination parameters to limit the results.", "operationId":"metric::Metrics::readForAllDevices", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricMetricsReadForAllDevices" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Metrics-readForAllDevices-get", "x-filename-id":"api-metric-metrics-readforalldevices-get" } }, "/api/metric/AbnormalProfiles/{id}":{ "get":{ "tags":[ "Metrics/Abnormal Profiles" ], "summary":"Get an Abnormal Profile by ID", "description":"Gets the abnormal profile that matches the specified ID. Abnormal profiles are used by abnormal thresholds and the Metric Abnormal Threshold Engine.", "operationId":"metric::AbnormalProfiles::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the abnormal profile to get.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricAbnormalProfilesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-AbnormalProfiles-{id}-get", "x-filename-id":"api-metric-abnormalprofiles-id-get" }, "put":{ "tags":[ "Metrics/Abnormal Profiles" ], "summary":"Update an Abnormal Profile", "description":"Updates the abnormal profile that matches the specified ID. Abnormal profiles are used by abnormal thresholds and the Metric Abnormal Threshold Engine.", "operationId":"metric::AbnormalProfiles::update", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the abnormal profile to update.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/metricAbnormalProfiles" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricAbnormalProfilesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-AbnormalProfiles-{id}-put", "x-filename-id":"api-metric-abnormalprofiles-id-put" }, "delete":{ "tags":[ "Metrics/Abnormal Profiles" ], "summary":"Delete an Abnormal Profile", "description":"Deletes the abnormal profile that matches the specified ID. Abnormal profiles are used by abnormal thresholds and the Metric Abnormal Threshold Engine.", "operationId":"metric::AbnormalProfiles::delete", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the abnormal profile to delete.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-AbnormalProfiles-{id}-delete", "x-filename-id":"api-metric-abnormalprofiles-id-delete" } }, "/api/metric/AbnormalProfiles":{ "get":{ "tags":[ "Metrics/Abnormal Profiles" ], "summary":"Get Abnormal Profiles", "description":"Gets the abnormal profiles that match the specified query parameters. Abnormal profiles are used by abnormal thresholds and the Metric Abnormal Threshold Engine. If no parameters are specified, all abnormal profiles are returned.", "operationId":"metric::AbnormalProfiles::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricAbnormalProfilesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-AbnormalProfiles-get", "x-filename-id":"api-metric-abnormalprofiles-get" }, "post":{ "tags":[ "Metrics/Abnormal Profiles" ], "summary":"Create an Abnormal Profile", "description":"Creates an abnormal profile that can be used by abnormal thresholds and the Metric Abnormal Threshold Engine.
The minimum required properties in the request body are:\n ", "operationId":"metric::AbnormalProfiles::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/metricAbnormalProfiles", "required":[ "AbnormalProfileName", "Alpha", "Beta", "Gamma", "Delta", "Epsilon", "FailureThreshold", "WindowLength" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricAbnormalProfilesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-AbnormalProfiles-post", "x-filename-id":"api-metric-abnormalprofiles-post" } }, "/api/metric/AbnormalProfiles/readForSelect":{ "get":{ "tags":[ "Metrics/Abnormal Profiles" ], "summary":"Get Abnormal Profiles for Combo Boxes and Item Selectors", "description":"Gets the abnormal profiles that match the specified query parameters in a format suitable for combo boxes and item selectors. If no parameters are specified, all abnormal profiles are returned.", "operationId":"metric::AbnormalProfiles::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricAbnormalProfilesReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-AbnormalProfiles-readForSelect-get", "x-filename-id":"api-metric-abnormalprofiles-readforselect-get" } }, "/api/metric/allMetricsOverview":{ "get":{ "tags":[ "Metrics/All Metrics Overview" ], "summary":"Get Metrics for an Instance", "description":"Gets the metrics for the specified instance that match the query parameters.
\nBy default, the response contains metrics and their values. You can set the ExcludeMetricValues parameter to 1 to return only the metric definitions. Because this avoids querying the Metrics database and calculating the values, the response will be returned faster.\nExample paths:\n", "operationId":"metric::AllMetricsOverview::read", "parameters":[ { "name":"id", "in":"query", "description":"A serialized device name or comma-separated list of serialized device names. Only used if the DeviceSource parameter is set to Device or MultipleDevices.", "schema":{ "type":"string" }, "example":"router.example.com;z1 OR router.example.com" }, { "name":"TimeRange", "in":"query", "schema":{ "allOf":[ { "$ref":"#/components/parameters/TimeRange" } ] } }, { "name":"DeviceSource", "in":"query", "description":"Which device or devices to include. If no source is set, it assumes a single device.\nAllowed Values:\n", "schema":{ "type":"string" }, "example":"Device" }, { "name":"DeviceGroup", "in":"query", "description":"The device group. Only used if DeviceSource is set to DeviceGroup.", "schema":{ "type":"string" }, "example":"//Root//Group1" }, { "name":"MetricSource", "in":"query", "description":"Which metrics to include. If no source is set, all metrics are included.\nAllowed Values:\n", "schema":{ "type":"string" }, "example":"All" }, { "name":"MetricGroup", "in":"query", "description":"The metric group to include. Only used if MetricSource is set to MetricGroup.", "schema":{ "type":"string" }, "example":"Device Health" }, { "name":"MetricType", "in":"query", "description":"The metric type to include. Only used if MetricSource is set to MetricTypeName.", "schema":{ "type":"string" }, "example":"Latency" }, { "name":"MetricTypes", "in":"query", "description":"The list of metric types to include. Only used if MetricSource is set to MetricTypes.", "schema":{ "type":"array", "items":{ "type":"object", "properties":{ "MetricTypeID":{ "description":"The metric type ID.", "type":"integer", "example":515 }, "MetricTypeName":{ "description":"The metric type name.", "type":"string", "example":"Apache Accesses" }, "Measurement":{ "description":"The InfluxDB measurement name.", "type":"string", "example":"metrictype_Apache_Accesses" } } } }, "example":"Latency" }, { "name":"Metrics", "in":"query", "description":"The list of metrics to include in the response, formatted as an array of objects.
You can specify metrics either by ID, or by a combination of device, instance, and metric type name. If you include both ID and names for a metric, only the ID is considered. If you specify by names, you must include all three name parameters. You can also specify some metrics by ID and others by names in the same request. ", "schema":{ "type":"array", "items":{ "type":"object", "properties":{ "MetricID":{ "description":"The metric ID.", "type":"integer", "example":515 }, "DeviceName":{ "description":"The device name, including the zone ID (serialized device name).", "type":"string", "example":"router.example.com;z1" }, "InstanceName":{ "description":"The name of the metric instance, corresponding to the InstanceName field in the MetricInstances database table.", "type":"string", "example":"Device" }, "MetricTypeName":{ "description":"The metric type name.", "type":"string", "example":"Apache Accesses" } } } }, "example":"Latency" }, { "name":"DeviceZoneName", "in":"query", "description":"The device zone name. Only used if DeviceSource is set to DeviceZone.", "schema":{ "type":"string" }, "example":"Oracle Lab - Network Equipment" }, { "name":"ShowMetricGroup", "in":"query", "description":"Whether the entire metric group should be included (1) or not (0). Only used if MetricSource is set to MetricTypeName or MetricTypes.", "schema":{ "type":"boolean" } }, { "name":"ExcludeDisabled", "in":"query", "description":"Whether to exclude disabled devices (1) or not (0).", "schema":{ "type":"boolean" } }, { "name":"ExcludeMetricValues", "in":"query", "description":"Whether to exclude metric values (1) or not (0). If 1, the API will not query the metric database and compute the metric values. Also the API will take less time to run.", "schema":{ "type":"boolean" } }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/group" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricAllMetricsOverviewRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-allMetricsOverview-get", "x-filename-id":"api-metric-allmetricsoverview-get" } }, "/api/metric/AvailabilityData/read":{ "get":{ "tags":[ "Metrics/Metric Availability Data" ], "summary":"Get Metric Availability Data", "description":"Gets availability data for metrics of the specified instance.\n
\nValid request combinations:\n
\n", "operationId":"metric::AvailabilityData::read", "parameters":[ { "name":"DeviceName", "in":"query", "required":true, "schema":{ "allOf":[ { "$ref":"#/components/schemas/metricPerformanceData/properties/DeviceName" } ] } }, { "name":"MetricType", "in":"query", "required":true, "schema":{ "allOf":[ { "$ref":"#/components/schemas/metricPerformanceData/properties/MetricType" } ] } }, { "name":"InstanceName", "in":"query", "description":"The metric instance name corresponding to metricInstances.", "required":true, "schema":{ "type":"string" }, "example":"Device" }, { "name":"DeviceZoneID", "in":"query", "description":"The ID of the device zone to get performance data for. Deprecated. Use serialized device name instead.", "schema":{ "type":"integer" }, "example":"1" }, { "name":"TimeRange", "in":"query", "required":false, "schema":{ "allOf":[ { "$ref":"#/components/parameters/TimeRange" } ] } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricAvailabilityDataRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-AvailabilityData-read-get", "x-filename-id":"api-metric-availabilitydata-read-get" } }, "/api/metric/AvailabilityData/readSummary":{ "get":{ "tags":[ "Metrics/Metric Availability Data" ], "summary":"Get a Summary of Availability Information for an Instance", "description":"Gets a summary in pie chart format of availability information for the specified instance.
An example path with query parameters is:\n
/api/metric/AvailabilityData/readSummary?DeviceName=router.example.com%3Bz3&MetricType=Latency&InstanceName=Device", "operationId":"metric::AvailabilityData::readSummary", "parameters":[ { "name":"DeviceName", "in":"query", "description":"The device name, including the zone ID (serialized device name). Oracle recommends including the zone ID with the device name. If you do not, you must include it in the DeviceZoneID parameter.", "required":true, "schema":{ "type":"string", "example":"router.example.com;z1 OR router.example.com" } }, { "name":"MetricType", "in":"query", "description":"The metric type name corresponding to the MetricTypes database table MetricTypeName field.", "required":true, "schema":{ "type":"string" }, "example":"Latency" }, { "name":"InstanceName", "in":"query", "description":"The metric instance name corresponding to the MetricInstances database table InstanceName field.", "required":true, "schema":{ "type":"string" }, "example":"Device" }, { "name":"DeviceZoneID", "in":"query", "description":"The database ID corresponding to the device zone. Deprecated. Use serialized device name instead.", "schema":{ "type":"integer" }, "example":1 }, { "name":"TimeRange", "in":"query", "required":false, "schema":{ "allOf":[ { "$ref":"#/components/parameters/TimeRange" } ] } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricAvailabilityDataReadSummary" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-AvailabilityData-readSummary-get", "x-filename-id":"api-metric-availabilitydata-readsummary-get" } }, "/api/metric/Calculations/{id}":{ "get":{ "tags":[ "Metrics/Calculations" ], "summary":"Get a Calculation Policy by ID", "description":"Gets the calculation policy that matches the specified ID.", "operationId":"metric::Calculations::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the calculation policy to get.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricCalculationsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Calculations-{id}-get", "x-filename-id":"api-metric-calculations-id-get" }, "put":{ "tags":[ "Metrics/Calculations" ], "summary":"Update a Calculation Policy", "description":"Updates the calculation policy that matches the specified ID.", "operationId":"metric::Calculations::update", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the calculation policy to update.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/metricCalculations" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricCalculationsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Calculations-{id}-put", "x-filename-id":"api-metric-calculations-id-put" }, "delete":{ "tags":[ "Metrics/Calculations" ], "summary":"Delete a Calculation Policy", "description":"Deletes the calculation policy that matches the specified ID.", "operationId":"metric::Calculations::delete", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the calculation policy to delete.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Calculations-{id}-delete", "x-filename-id":"api-metric-calculations-id-delete" } }, "/api/metric/Calculations":{ "get":{ "tags":[ "Metrics/Calculations" ], "summary":"Get Calculation Policies", "description":"Gets the calculation policies that match the specified query parameters. If no parameters are specified, all calculation policies are returned.", "operationId":"metric::Calculations::read", "parameters":[ { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricCalculationsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Calculations-get", "x-filename-id":"api-metric-calculations-get" }, "post":{ "tags":[ "Metrics/Calculations" ], "summary":"Create a Calculation Policy", "description":"Creates a calculation policy.
The minimum required properties in the request body are:\n ", "operationId":"metric::Calculations::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/metricCalculations", "required":[ "PolicyName", "PolicyStatusID", "Collections" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricCalculationsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Calculations-post", "x-filename-id":"api-metric-calculations-post" } }, "/api/metric/Calculations/readForSelect":{ "get":{ "tags":[ "Metrics/Calculations" ], "summary":"Get Calculation Policies for Combo Boxes and Item Selectors", "description":"Gets the calculation policies that match the specified query parameters in a format suitable for combo boxes and item selectors. If no parameters are specified, all calculation policies are returned.", "operationId":"metric::Calculations::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricCalculationsReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Calculations-readForSelect-get", "x-filename-id":"api-metric-calculations-readforselect-get" } }, "/api/metric/Calculations/executeCheckSyntax":{ "post":{ "tags":[ "Metrics/Calculations" ], "summary":"Check Syntax for a Calculation Policy", "description":"Runs the calculation policy file provided in the request body through the CheckSyntax utility and returns the result. The Content property is required in the request body.", "operationId":"metric::Calculations::executeCheckSyntax", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/metricCalculationsExecuteCheckSyntax" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the request was a success (true) or a failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The syntax check response message.", "type":"string", "example":"Syntax Check OK" } }, "type":"object" } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Calculations-executeCheckSyntax-post", "x-filename-id":"api-metric-calculations-executechecksyntax-post" } }, "/api/metric/Categories/{id}":{ "get":{ "tags":[ "Metrics/Metric Categories" ], "summary":"Get a Metric Category by ID", "description":"Gets the metric category that matches the specified ID.", "operationId":"metric::Categories::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the metric DDO category to get.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricCategoriesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Categories-{id}-get", "x-filename-id":"api-metric-categories-id-get" }, "put":{ "tags":[ "Metrics/Metric Categories" ], "summary":"Update a Metric Category", "description":"Updates the metric category that matches the specified ID.", "operationId":"metric::Categories::update", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the metric DDO category to update.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/metricCategories" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricCategoriesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Categories-{id}-put", "x-filename-id":"api-metric-categories-id-put" }, "delete":{ "tags":[ "Metrics/Metric Categories" ], "summary":"Delete a Metric Category", "description":"Deletes the metric category that matches the specified ID.", "operationId":"metric::Categories::delete", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the metric DDO category to delete.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Categories-{id}-delete", "x-filename-id":"api-metric-categories-id-delete" } }, "/api/metric/Categories":{ "get":{ "tags":[ "Metrics/Metric Categories" ], "summary":"Get Metric Categories", "description":"Gets the metric categories that match the specified query parameters. If no parameters are specified, all metric categories are returned.", "operationId":"metric::Categories::read", "parameters":[ { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricCategoriesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Categories-get", "x-filename-id":"api-metric-categories-get" }, "post":{ "tags":[ "Metrics/Metric Categories" ], "summary":"Create a Metric Category", "description":"Creates a metric category.
The minimum required properties in the request body are:\n ", "operationId":"metric::Categories::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/metricCategories", "required":[ "MetricDDOCategoryName", "MetricDDOCategoryPath", "TabOrder", "MetricTypes" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricCategoriesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Categories-post", "x-filename-id":"api-metric-categories-post" } }, "/api/metric/Categories/readForSelect":{ "get":{ "tags":[ "Metrics/Metric Categories" ], "summary":"Get Metric Categories for Combo Boxes and Item Selectors", "description":"Get the metric categories that match the specified query parameters in a format suitable for combo boxes and item selectors. If no parameters are specified, all metric categories are returned.", "operationId":"metric::Categories::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricCategoriesReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Categories-readForSelect-get", "x-filename-id":"api-metric-categories-readforselect-get" } }, "/api/metric/Categories/readMetricTabs":{ "get":{ "tags":[ "Metrics/Metric Categories" ], "summary":"Get the Metric Tabs for a Device", "description":"Gets the metric tabs that are available for the specified device, to be used by the dynamic tab portlet.
An example path with query parameters is:
/api/metric/Categories/readMetricTabs?DeviceName=router.example.com;z1", "operationId":"metric::Categories::readMetricTabs", "parameters":[ { "name":"DeviceID", "in":"query", "description":"The ID of the device to get metric tabs for. Specify either DeviceName or DeviceID. DeviceName will be given preference if you specify both.", "schema":{ "type":"integer", "format":"int32" }, "example":1 }, { "name":"DeviceName", "in":"query", "description":"The serialized name of the device to get metric tabs for. Specify either DeviceName or DeviceID. DeviceName will be given preference if you specify both.", "schema":{ "type":"string" }, "example":"router.example.com;z1 OR router.example.com" }, { "name":"DeviceZoneID", "in":"query", "description":"The device zone ID.", "schema":{ "type":"integer" }, "example":1 }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricCategoriesReadMetricTabs" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Categories-readMetricTabs-get", "x-filename-id":"api-metric-categories-readmetrictabs-get" } }, "/api/metric/Categories/updateOrder":{ "put":{ "tags":[ "Metrics/Metric Categories" ], "summary":"Update the Order of Metric Tabs", "description":"Updates the order of the metric tabs.", "operationId":"metric::Categories::updateOrder", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "NewOrder":{ "description":"The tab order index for the categories. An array of all CategoryIDs, which are reordered from 1 to N", "type":"array", "items":{ "type":"integer" } } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the request was a success (true) or a failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message.", "type":"string", "example":"Updated order" }, "data":{ "type":"array", "items":{ }, "example":[ ] } } } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Categories-updateOrder-put", "x-filename-id":"api-metric-categories-updateorder-put" } }, "/api/metric/Collections/{id}":{ "get":{ "tags":[ "Metrics/Metric Collections" ], "summary":"Get a Metric Collection by ID", "description":"Gets the metric collection that matches the specified ID.", "operationId":"metric::Collections::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the metric collection to get.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricCollectionsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Collections-{id}-get", "x-filename-id":"api-metric-collections-id-get" }, "put":{ "tags":[ "Metrics/Metric Collections" ], "summary":"Update a Metric Collection", "description":"Updates the metric collection that matches the specified ID.", "operationId":"metric::Collections::update", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the metric collection to update.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/metricCollections" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricCollectionsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Collections-{id}-put", "x-filename-id":"api-metric-collections-id-put" }, "delete":{ "tags":[ "Metrics/Metric Collections" ], "summary":"Delete a Metric Collection", "description":"Deletes the metric collection that matches the specified ID.", "operationId":"metric::Collections::delete", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the metric collection to delete.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Collections-{id}-delete", "x-filename-id":"api-metric-collections-id-delete" } }, "/api/metric/Collections":{ "get":{ "tags":[ "Metrics/Metric Collections" ], "summary":"Get Metric Collections", "description":"Gets the metric collections that match the specified query parameters. If no parameters are specified, all metric collections are returned.", "operationId":"metric::Collections::read", "parameters":[ { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricCollectionsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Collections-get", "x-filename-id":"api-metric-collections-get" }, "post":{ "tags":[ "Metrics/Metric Collections" ], "summary":"Create a Metric Collection", "description":"Creates a metric collection.
The minimum required properties in the request body are:\n ", "operationId":"metric::Collections::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/metricCollections", "required":[ "CollectionName", "Metrics", "TabOrder", "MetricTypes" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricCollectionsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Collections-post", "x-filename-id":"api-metric-collections-post" } }, "/api/metric/Collections/readForSelect":{ "get":{ "tags":[ "Metrics/Metric Collections" ], "summary":"Get Metric Collections for Combo Boxes and Item Selectors", "description":"Get the metric collections that match the specified query parameters in a format suitable for combo boxes and item selectors. If no parameters are specified, all metric collections are returned.", "operationId":"metric::Collections::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricCollectionsReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Collections-readForSelect-get", "x-filename-id":"api-metric-collections-readforselect-get" } }, "/api/metric/Collections/readMetricsForSelect":{ "get":{ "tags":[ "Metrics/Metric Collections" ], "summary":"Get Metrics in Metric Collections for Combo Boxes and Item Selectors", "description":"Get the metrics for metric collections that match the specified query parameters in a format suitable for combo boxes and item selectors. If no parameters are specified, all metrics are returned.", "operationId":"metric::Collections::readMetricsForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricCollectionsReadMetricsForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Collections-readMetricsForSelect-get", "x-filename-id":"api-metric-collections-readmetricsforselect-get" } }, "/api/metric/DeviceGroupAvailabilityData":{ "get":{ "tags":[ "Metrics/Metric Device Group Availability Data" ], "summary":"Get Availability Data for a Device Group", "description":"Gets the availability data for the specified device group.", "operationId":"metric::DeviceGroupAvailabilityData::read", "parameters":[ { "name":"DeviceGroup", "in":"query", "description":"The device group to get availability for.", "required":true, "schema":{ "type":"string" }, "example":"//Root//Oracle Lab - test" }, { "name":"TimeRange", "in":"query", "description":"A shorthand string that encompasses StartTime and StopTime. Overwrites any value set for StartTime and StopTime.", "required":true, "schema":{ "type":"string" }, "example":"now-24h..now" }, { "name":"DisableNavigation", "in":"query", "description":"Whether a user can click a navigation folder to load the group's parent or children (0) or not (1). If navigation is disabled (1), all information about child folders and the \"Go up\" link are removed from the result set.", "required":true, "schema":{ "type":"boolean" }, "example":0 }, { "name":"StartTime", "in":"query", "description":"The start time.", "schema":{ "type":"string" }, "example":"now - 24h" }, { "name":"StopTime", "in":"query", "description":"The stop time.", "schema":{ "type":"string" }, "example":"now" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricDeviceGroupAvailabilityDataRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-DeviceGroupAvailabilityData-get", "x-filename-id":"api-metric-devicegroupavailabilitydata-get" } }, "/api/metric/DeviceGroupAvailabilityData/readGroupName":{ "get":{ "tags":[ "Metrics/Metric Device Group Availability Data" ], "summary":"Get a Device Group Name", "description":"Gets the name of the specified device group.", "operationId":"metric::DeviceGroupAvailabilityData::readGroupName", "parameters":[ { "name":"DeviceGroupID", "in":"query", "description":"The ID of the device group to get the name for.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricDeviceGroupAvailabilityDataReadGroupName" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-DeviceGroupAvailabilityData-readGroupName-get", "x-filename-id":"api-metric-devicegroupavailabilitydata-readgroupname-get" } }, "/api/metric/DisplayInstances/{id}":{ "get":{ "tags":[ "Metrics/Display Instances" ], "summary":"Get a Metric Display Instance", "description":"Gets the metric display instance that matches the specified ID.", "operationId":"metric::DisplayInstances::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the display instance to get.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricDisplayInstancesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-DisplayInstances-{id}-get", "x-filename-id":"api-metric-displayinstances-id-get" }, "put":{ "tags":[ "Metrics/Display Instances" ], "summary":"Update a Metric Display Instance", "description":"Updates the metric display instance that matches the specified ID.", "operationId":"metric::DisplayInstances::update", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the display instance to update.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/metricDisplayInstances" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricDisplayInstancesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-DisplayInstances-{id}-put", "x-filename-id":"api-metric-displayinstances-id-put" }, "delete":{ "tags":[ "Metrics/Display Instances" ], "summary":"Delete a Metric Display Instance", "description":"Deletes the metric display instance that matches the specified ID.", "operationId":"metric::DisplayInstances::delete", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the display instance to delete.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-DisplayInstances-{id}-delete", "x-filename-id":"api-metric-displayinstances-id-delete" } }, "/api/metric/DisplayInstances":{ "get":{ "tags":[ "Metrics/Display Instances" ], "summary":"Get Metric Display Instances", "description":"Gets the metric display instances that match the specified query parameters. If no parameters are specified, all metric display instances are returned.", "operationId":"metric::DisplayInstances::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricDisplayInstancesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-DisplayInstances-get", "x-filename-id":"api-metric-displayinstances-get" }, "post":{ "tags":[ "Metrics/Display Instances" ], "summary":"Create a Metric Display Instance", "description":"Creates a metric display instance.
The minimum required properties in the request body are:\n ", "operationId":"metric::DisplayInstances::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/metricDisplayInstances", "required":[ "SourceDeviceID", "SourceDeviceName", "InstanceID", "MetricDisplayInstanceName" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricDisplayInstancesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-DisplayInstances-post", "x-filename-id":"api-metric-displayinstances-post" } }, "/api/metric/DisplayInstances/readForSelect":{ "get":{ "tags":[ "Metrics/Display Instances" ], "summary":"Get Metric Display Instances for Combo Boxes and Item Selectors", "description":"Gets the metric display instances that match the specified query parameters in a format suitable for combo boxes and item selectors. If no parameters are specified, all metric display instances are returned.", "operationId":"metric::DisplayInstances::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricDisplayInstancesReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-DisplayInstances-readForSelect-get", "x-filename-id":"api-metric-displayinstances-readforselect-get" } }, "/api/metric/Instances/{id}":{ "get":{ "tags":[ "Metrics/Metric Instances" ], "summary":"Get a Metric Instance by ID", "description":"Gets the metric instance that matches the specified ID.", "operationId":"metric::Instances::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the metric instance to get.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricInstancesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Instances-{id}-get", "x-filename-id":"api-metric-instances-id-get" }, "put":{ "tags":[ "Metrics/Metric Instances" ], "summary":"Update a Metric Instance", "description":"Updates the metric instance that matches the specified ID.", "operationId":"metric::Instances::update", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the metric instance to update.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/metricInstancesPut" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricInstancesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Instances-{id}-put", "x-filename-id":"api-metric-instances-id-put" }, "delete":{ "tags":[ "Metrics/Metric Instances" ], "summary":"Delete a Metric Instance", "description":"Deletes the metric instance that matches the specified ID.", "operationId":"metric::Instances::delete", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the metric instance to delete.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Instances-{id}-delete", "x-filename-id":"api-metric-instances-id-delete" } }, "/api/metric/Instances":{ "get":{ "tags":[ "Metrics/Metric Instances" ], "summary":"Get Metric Instances", "description":"Gets the metric instances that match the specified query parameters. If no parameters are specified, all metric instances are returned.", "operationId":"metric::Instances::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricInstancesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Instances-get", "x-filename-id":"api-metric-instances-get" }, "post":{ "tags":[ "Metrics/Metric Instances" ], "summary":"Create a Metric Instance", "description":"Creates a metric instance.
The minimum required properties in the request body are:\n ", "operationId":"metric::Instances::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/metricInstances", "required":[ "InstanceName", "InstanceTypeID" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricInstancesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Instances-post", "x-filename-id":"api-metric-instances-post" } }, "/api/metric/Instances/readForSelect":{ "get":{ "tags":[ "Metrics/Metric Instances" ], "summary":"Get Metric Instances for Combo Boxes and Item Selectors", "description":"Get the metric instances that match the specified query parameters in a format suitable for combo boxes and item selectors. If no parameters are specified, all metric instances are returned.", "operationId":"metric::Instances::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricInstancesReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Instances-readForSelect-get", "x-filename-id":"api-metric-instances-readforselect-get" } }, "/api/metric/Instances/readForSelectByDevice":{ "get":{ "tags":[ "Metrics/Metric Instances" ], "summary":"Get Metric Instances for a Device for Combo Boxes and Item Selectors", "description":"Get the metric instances for a device that match the specified query parameters in a format suitable for combo boxes and item selectors. If no parameters are specified, all metric instances for the device are returned.", "operationId":"metric::Instances::readForSelectByDevice", "parameters":[ { "name":"id", "in":"query", "description":"The ID of the metric instance to get.", "schema":{ "type":"integer", "format":"int32" }, "example":"276229" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricInstancesReadForSelectByDevice" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Instances-readForSelectByDevice-get", "x-filename-id":"api-metric-instances-readforselectbydevice-get" } }, "/api/metric/Measurements/{name}":{ "get":{ "tags":[ "Metrics/Measurements" ], "summary":"Get a Measurement by Name", "description":"Gets the measurement that matches the specified name. This can be a measurement name, prefixed with metrictype_, or a metric type name.", "operationId":"metric::Measurements::Read_byID", "parameters":[ { "name":"name", "in":"path", "description":"The name of the measurement to get. This can be a measurement name, prefixed with metrictype_, or a metric type name.", "required":true, "schema":{ "type":"string" }, "examples":{ "metricTypeName":{ "value":"Interface Inbound Bandwidth" }, "measurementName":{ "value":"metrictype_CPU_Utilization" } } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricMeasurementsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Measurements-{name}-get", "x-filename-id":"api-metric-measurements-name-get" } }, "/api/metric/Measurements":{ "get":{ "tags":[ "Metrics/Measurements" ], "summary":"Get Measurements", "description":"Gets the measurements that match the specified query parameters. If no parameters are specified, all measurements are returned.", "operationId":"metric::Measurements::read", "parameters":[ { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricMeasurementsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Measurements-get", "x-filename-id":"api-metric-measurements-get" } }, "/api/metric/MetricGroups/{id}":{ "get":{ "tags":[ "Metrics/Metric Groups" ], "summary":"Get a Metric Group by ID", "description":"Gets the metric group that matches the specified ID.", "operationId":"metric::MetricGroups::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the metric group to get.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricMetricGroupsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-MetricGroups-{id}-get", "x-filename-id":"api-metric-metricgroups-id-get" }, "put":{ "tags":[ "Metrics/Metric Groups" ], "summary":"Update a Metric Group", "description":"Updates the metric group that matches the specified ID.", "operationId":"metric::MetricGroups::update", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the metric group to update.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MetricGroups" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricMetricGroupsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-MetricGroups-{id}-put", "x-filename-id":"api-metric-metricgroups-id-put" }, "delete":{ "tags":[ "Metrics/Metric Groups" ], "summary":"Delete a Metric Group", "description":"Deletes the metric group that matches the specified ID.", "operationId":"metric::MetricGroups::delete", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the metric group to delete.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-MetricGroups-{id}-delete", "x-filename-id":"api-metric-metricgroups-id-delete" } }, "/api/metric/MetricGroups":{ "get":{ "tags":[ "Metrics/Metric Groups" ], "summary":"View all Metric Groups", "description":"Gets the metric groups that match the specified query parameters. If no parameters are specified, all metric groups are returned.", "operationId":"metric::MetricGroups::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricMetricGroupsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-MetricGroups-get", "x-filename-id":"api-metric-metricgroups-get" }, "post":{ "tags":[ "Metrics/Metric Groups" ], "summary":"Add a Metric Group", "description":"Creates a metric group.
The minimum required properties in the request body are:\n ", "operationId":"metric::MetricGroups::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MetricGroups", "required":[ "MetricGroupName", "Stacked", "MetricTypes" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricMetricGroupsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-MetricGroups-post", "x-filename-id":"api-metric-metricgroups-post" } }, "/api/metric/metricGroups/readForSelect":{ "get":{ "tags":[ "Metrics/Metric Groups" ], "summary":"Get Metric Groups for Combo Boxes and Item Selectors", "description":"Get the metric groups that match the specified query parameters in a format suitable for combo boxes and item selectors. If no parameters are specified, all metric groups are returned.", "operationId":"Metric::MetricGroups::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricMetricGroupsReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-metricGroups-readForSelect-get", "x-filename-id":"api-metric-metricgroups-readforselect-get" } }, "/api/metric/NetworkTraffic":{ "get":{ "tags":[ "Metrics/Network Traffic" ], "summary":"Get Metrics for a Device", "description":"Get the metrics for a specified device that match the specified query parameters. If no optional query parameters are specified, all metrics for the device are returned.
An example path with query parameters is:\n
/api/metric/NetworkTraffic?TimeRange=now-24h..now&DeviceName=router.example.com%3Bz3&page=1&start=0&limit=1000&group=%7B%22property%22%3A%22InstanceName%22%2C%22direction%22%3A%22ASC%22%7D&sort=%5B%7B%22property%22%3A%22InstanceName%22%2C%22direction%22%3A%22ASC%22%7D%2C%7B%22property%22%3A%22MetricTypeName%22%2C%22direction%22%3A%22ASC%22%7D%5D", "operationId":"metric::NetworkTraffic::read", "parameters":[ { "name":"DeviceName", "in":"query", "description":"The device name, including the zone ID (serialized device name). Oracle recommends including the zone ID with the device name. If you do not, you must include it in the DeviceZoneID parameter.", "required":true, "schema":{ "type":"string", "example":"router.example.com;z1 OR router.example.com" } }, { "name":"DeviceZoneID", "in":"query", "description":"The database ID of the device zone to get metrics for. Deprecated. Use serialized device name instead.", "required":false, "schema":{ "type":"integer" }, "example":1 }, { "name":"TimeRange", "in":"query", "required":false, "schema":{ "allOf":[ { "$ref":"#/components/parameters/TimeRange" } ] } }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/group" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricNetworkTrafficRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-NetworkTraffic-get", "x-filename-id":"api-metric-networktraffic-get" } }, "/api/metric/PerformanceData":{ "get":{ "tags":[ "Metrics/Performance Data" ], "summary":"Get Performance Data", "description":"Gets the performance data that matches the specified query parameters. If no parameters are specified, all performance data are returned. Oracle recommends using filtering and pagination parameters to limit the results.\n

\nIdentify the series you want performance data for by specifying Serialized DeviceName, either Measurement or MetricType, and Instance. For example, use the following in your request:\n
\n

/api/metric/PerformanceData?DeviceName=router.example.com;z1&Measurement=metrictype_Latency&Instance=Device
\n

\nIdentify the time ranges you want performance data for by specifying TimeRange, with start and end separated by ...
Use the following letters to indicate units of time: m for minute, h for hour, d for day, w for week, M for month, and y for year. Use now to get dates relative to the current day. You can also enter an absolute time in YYYY-MM-DD HH-MM-SS format.\n
\nFor example:\n

\nUsing the StartTime and StopTime parameters to specify time ranges is deprecated.\n
\nThe level of aggregation for values is determined by the time range and will automatically pick the best database retention policy.\n

\nValid request combinations are:\n

", "operationId":"metric::PerformanceData::read", "parameters":[ { "name":"DeviceID", "in":"query", "required":false, "schema":{ "allOf":[ { "$ref":"#/components/schemas/metricPerformanceData/properties/DeviceID" } ] } }, { "name":"MetricID", "in":"query", "required":false, "schema":{ "allOf":[ { "$ref":"#/components/schemas/metricPerformanceData/properties/MetricID" } ] } }, { "name":"DeviceName", "in":"query", "required":false, "schema":{ "allOf":[ { "$ref":"#/components/schemas/metricPerformanceData/properties/DeviceName" } ] } }, { "name":"DeviceZoneName", "in":"query", "required":false, "description":"Device zone name. Deprecated. Use serialized device name instead.", "schema":{ "type":"string" } }, { "name":"DeviceZoneID", "in":"query", "description":"The ID of the device zone to get performance data for. Deprecated. Use serialized device name instead.", "schema":{ "type":"integer" }, "example":"1" }, { "name":"MetricType", "in":"query", "required":false, "schema":{ "allOf":[ { "$ref":"#/components/schemas/metricPerformanceData/properties/MetricType" } ] } }, { "name":"Navigator", "in":"query", "required":false, "description":"Whether to include the NavigatorPoints navigation series (1) or not (0).", "schema":{ "type":"boolean" } }, { "name":"Instance", "in":"query", "required":false, "schema":{ "allOf":[ { "$ref":"#/components/schemas/metricPerformanceData/properties/Instance" } ] } }, { "name":"GraphTitle", "in":"query", "required":false, "schema":{ "allOf":[ { "$ref":"#/components/schemas/metricPerformanceData/properties/GraphTitle" } ] } }, { "name":"ShowMetricGroup", "in":"query", "required":false, "schema":{ "allOf":[ { "$ref":"#/components/schemas/metricPerformanceData/properties/ShowMetricGroup" } ] } }, { "name":"StartTime", "in":"query", "required":false, "description":"Deprecated way of specifying start time. Use the TimeRange parameter instead.", "schema":{ "allOf":[ { "$ref":"#/components/parameters/StartTime" } ] } }, { "name":"StopTime", "in":"query", "required":false, "description":"Deprecated way of specifying stop time. Use the TimeRange parameter instead.", "schema":{ "allOf":[ { "$ref":"#/components/parameters/StopTime" } ] } }, { "name":"TimeRange", "in":"query", "required":false, "schema":{ "allOf":[ { "$ref":"#/components/parameters/TimeRange" } ] } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Success or failure response", "type":"boolean", "example":"true" }, "message":{ "description":"The text of the response message.", "type":"string", "example":"Loaded 1 entries" }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The performance data.", "type":"array", "items":{ "$ref":"#/components/schemas/metricPerformanceDataRead" } } }, "type":"object" } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-PerformanceData-get", "x-filename-id":"api-metric-performancedata-get" } }, "/api/metric/PerformanceData/readMetrics":{ "get":{ "tags":[ "Metrics/Performance Data" ], "summary":"Get Information About Metrics for Graphs", "description":"Gets information about existing metrics that can be graphed.
An example path with query parameters is:\n
/api/metric/PerformanceData/readMetrics?page=1&start=0&limit=10&sort=%5B%7B%22property%22%3A%22DeviceName%22%2C%22direction%22%3A%22ASC%22%7D%5D", "operationId":"metric::PerformanceData::readMetrics", "parameters":[ { "name":"MetricID", "in":"query", "required":false, "schema":{ "allOf":[ { "$ref":"#/components/schemas/metricPerformanceData/properties/MetricID" } ] } }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The metric information that can be graphed.", "type":"array", "items":{ "$ref":"#/components/schemas/metricPerformanceDataReadMetrics" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-PerformanceData-readMetrics-get", "x-filename-id":"api-metric-performancedata-readmetrics-get" } }, "/api/metric/PerformanceData/readSummary":{ "get":{ "tags":[ "Metrics/Performance Data" ], "summary":"Get Summary Performance Information", "description":"Gets summary, or legend, performance information. You can specify either of the following combinations: \n\nIf you specify both, the IDs takes precedence.", "operationId":"metric::PerformanceData::readSummary", "parameters":[ { "name":"MetricID", "in":"query", "required":false, "description":"The ID of the metric to get performance information for (or multiple, comma-separated metric IDs).", "schema":{ "allOf":[ { "$ref":"#/components/schemas/metricPerformanceData/properties/MetricID" } ] } }, { "name":"DeviceID", "in":"query", "required":false, "description":"The ID of the device to get performance information for (or multiple, comma-separated device IDs).", "schema":{ "allOf":[ { "$ref":"#/components/schemas/metricPerformanceData/properties/DeviceID" } ] } }, { "name":"DeviceName", "in":"query", "required":false, "description":"The name of the device to get performance information for (or multiple, comma-separated device names).", "schema":{ "allOf":[ { "$ref":"#/components/schemas/metricPerformanceData/properties/DeviceName" } ] } }, { "name":"DeviceZoneName", "in":"query", "required":false, "description":"The name of the device zone to get performance information for. Deprecated. Use serialized device name instead.", "schema":{ "type":"string" } }, { "name":"MetricType", "in":"query", "required":false, "description":"The name of the metric type to get performance information for.", "schema":{ "type":"string" } }, { "name":"InstanceName", "in":"query", "required":false, "description":"The name of the metric instance to get performance information for.", "schema":{ "type":"string" } }, { "name":"StartTime", "in":"query", "required":false, "description":"The start time in epoch time seconds.", "schema":{ "allOf":[ { "$ref":"#/components/parameters/StartTime" } ] } }, { "name":"StopTime", "in":"query", "required":false, "description":"The stop time in epoch time seconds.", "schema":{ "allOf":[ { "$ref":"#/components/parameters/StopTime" } ] } }, { "name":"TimeRange", "in":"query", "required":false, "description":"A shorthand string that encompasses the start and end times in RFC3339 format or relative time literal format. Takes precedence over StartTime if both are passed in.", "schema":{ "allOf":[ { "$ref":"#/components/parameters/TimeRange" } ] } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"The performance data summary that matches the query parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/metricPerformanceDataReadSummary" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-PerformanceData-readSummary-get", "x-filename-id":"api-metric-performancedata-readsummary-get" } }, "/api/metric/PerformanceData/readForNavigator":{ "get":{ "tags":[ "Metrics/Performance Data" ], "summary":"Get a Navigator Series for a Chart Display", "description":"Gets the navigator series that matches the specified parameters for a chart display.
An example path with query parameters is:\n
/api/metric/PerformanceData/readForNavigator?NavigatorParams=%7B%22264%22%3A%7B%22retention%22%3A%22daily%22%2C%22measurement%22%3A%22metrictype_Latency%22%2C%22zone%22%3A%22zone%20%20%20%20%20%3D%20%20%273%27%22%2C%22device%22%3A%22(%20host%20%3D%20%27router.example.com%27%20OR%20host%20%3D%20%27127:0:0:1%27%20)%22%2C%22instance%22%3A%22Device%22%2C%22dbConn%22%3A%221%22%7D%7D", "operationId":"metric::PerformanceData::readForNavigator", "parameters":[ { "name":"NavigatorParams", "in":"query", "description":"The information necessary for loading the navigation asynchronously.", "schema":{ "type":"array", "items":{ "type":"object", "properties":{ "retention":{ "description":"The retention period used for the navigation.", "type":"string" }, "measurement":{ "description":"The metric measurement used for the data.", "type":"string" }, "zone":{ "description":"The influx query clause for the zone.", "type":"string" }, "device":{ "description":"The influx query clause for the device.", "type":"string" }, "instance":{ "description":"The instance name.", "type":"string" }, "dbConn":{ "description":"The database connection ID.", "type":"integer" } } } } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"The navigator series that matches the query parameters.", "type":"array", "items":{ "type":"object", "properties":{ "MetricID":{ "type":"integer", "description":"The metric ID.", "example":1 }, "Timestamp":{ "type":"integer", "description":"The epoch time value.", "example":"1696324800000" }, "Value":{ "type":"number", "description":"The navigator value for the given metric at the given time.", "example":"0.000508975982666016" } } } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-PerformanceData-readForNavigator-get", "x-filename-id":"api-metric-performancedata-readfornavigator-get" } }, "/api/metric/PerformanceData/readDetails":{ "get":{ "tags":[ "Metrics/Performance Data" ], "summary":"Get Performance Data Details for a Grid Display", "description":"Gets performance data details for a grid display. You can specify any of the following combinations: \n\nIf you specify both, the names take precedence.", "operationId":"metric::PerformanceData::readDetails", "parameters":[ { "name":"MetricID", "in":"query", "schema":{ "allOf":[ { "$ref":"#/components/schemas/metricPerformanceData/properties/MetricID" } ] } }, { "name":"DeviceID", "in":"query", "schema":{ "allOf":[ { "$ref":"#/components/schemas/metricPerformanceData/properties/DeviceID" } ] } }, { "name":"DeviceName", "in":"query", "schema":{ "allOf":[ { "$ref":"#/components/schemas/metricPerformanceData/properties/DeviceName" } ] } }, { "name":"MetricType", "in":"query", "schema":{ "allOf":[ { "$ref":"#/components/schemas/metricPerformanceData/properties/MetricType" } ] } }, { "name":"TimeRange", "in":"query", "schema":{ "allOf":[ { "$ref":"#/components/parameters/TimeRange" } ] } }, { "name":"Instance", "in":"query", "schema":{ "allOf":[ { "$ref":"#/components/schemas/metricPerformanceData/properties/Instance" } ] } }, { "name":"Delimiter", "in":"query", "required":false, "description":"The single character used to separate names in string values of the DeviceName, Instance, MetricType, and DeviceZoneName parameters.", "schema":{ "type":"string" } }, { "name":"ShowMetricGroup", "in":"query", "schema":{ "allOf":[ { "$ref":"#/components/schemas/metricPerformanceData/properties/ShowMetricGroup" } ] } }, { "name":"DeviceZoneName", "in":"query", "description":"The name of the device zone to get performance data for. Deprecated. Use serialized device name instead.", "schema":{ "type":"string" }, "example":"Default First Zone" }, { "name":"DeviceZoneID", "in":"query", "description":"The ID of the device zone to get performance data for. Deprecated. Use serialized device name instead.", "schema":{ "type":"integer" }, "example":"1" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The data contents are dynamic based on the data to be gathered. It will always contain Time and EpochTime. Every other column will depend on the data. The values are the string \"Value_\" concatenated with the metric ID.", "type":"array", "items":{ "$ref":"#/components/schemas/metricPerformanceDataReadDetails" } }, "metaData":{ "description":"A description of the data.", "type":"array", "items":{ "type":"object", "properties":{ "GraphTitle":{ "description":"The title for the display.", "type":"string" }, "root":{ "description":"The name of the root data element.", "type":"string" }, "columns":{ "description":"A description of the columns the data should be displayed in.", "type":"array", "items":{ "type":"object", "properties":{ "dataIndex":{ "description":"The data index containing the data for this column.", "type":"string" }, "minWidth":{ "description":"The minimum width for the column in pixels.", "type":"integer" }, "test":{ "description":"The title for the column.", "type":"string" }, "width":{ "description":"The column width in pixels.", "type":"integer" }, "flex":{ "description":"The flex value if the column should use a dynamic width. If more than 1 column has a flex value, higher values indicates the column will get more space based on the flex ratios.", "type":"integer" } } } }, "fields":{ "description":"The data index to link data to the columns.", "type":"array", "items":{ "type":"string" } } } } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-PerformanceData-readDetails-get", "x-filename-id":"api-metric-performancedata-readdetails-get" } }, "/api/metric/PollerTemplates/{id}":{ "get":{ "tags":[ "Metrics/Poller Templates" ], "summary":"Get a Poller Template", "description":"Gets the Poller Template that matches the specified ID.", "operationId":"metric::PollerTemplates::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the poller template to get.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "description":"The poller template that matches the specified ID.", "items":{ "$ref":"#/components/schemas/metricPollerTemplatesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-PollerTemplates-{id}-get", "x-filename-id":"api-metric-pollertemplates-id-get" }, "put":{ "tags":[ "Metrics/Poller Templates" ], "summary":"Update a Poller Template", "description":"Updates the poller template that matches the specified ID.", "operationId":"metric::PollerTemplates::update", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the poller template to update.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/metricPollerTemplates" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "description":"The updated poller template.", "items":{ "$ref":"#/components/schemas/metricPollerTemplatesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-PollerTemplates-{id}-put", "x-filename-id":"api-metric-pollertemplates-id-put" }, "delete":{ "tags":[ "Metrics/Poller Templates" ], "summary":"Delete a Poller Template", "description":"Deletes the poller template that matches the specified ID.", "operationId":"metric::PollerTemplates::delete", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the poller template to delete.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-PollerTemplates-{id}-delete", "x-filename-id":"api-metric-pollertemplates-id-delete" } }, "/api/metric/PollerTemplates":{ "get":{ "tags":[ "Metrics/Poller Templates" ], "summary":"Get Poller Templates", "description":"Gets the poller templates that match the specified query parameters. If no parameters are specified, all poller templates are returned.", "operationId":"metric::PollerTemplates::read", "parameters":[ { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "description":"The poller templates that match the specified query parameters.", "items":{ "$ref":"#/components/schemas/metricPollerTemplatesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-PollerTemplates-get", "x-filename-id":"api-metric-pollertemplates-get" }, "post":{ "tags":[ "Metrics/Poller Templates" ], "summary":"Create a Poller Template", "description":"Creates a poller template.
The minimum required properties in the request body are:\n ", "operationId":"metric::PollerTemplates::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/metricPollerTemplates", "required":[ "TemplateName", "MetricTypes" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "description":"The new poller template.", "items":{ "$ref":"#/components/schemas/metricPollerTemplatesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-PollerTemplates-post", "x-filename-id":"api-metric-pollertemplates-post" } }, "/api/metric/PollerTemplates/readForSelect":{ "get":{ "tags":[ "Metrics/Poller Templates" ], "summary":"Get Poller Templates for Combo Boxes and Item Selectors", "description":"Gets the poller templates that match the specified query parameters in a format suitable for combo boxes and item selectors. If no parameters are specified, all poller templates are returned.", "operationId":"metric::PollerTemplates::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "description":"The poller templates that match the specified query parameters.", "items":{ "$ref":"#/components/schemas/metricPollerTemplatesReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-PollerTemplates-readForSelect-get", "x-filename-id":"api-metric-pollertemplates-readforselect-get" } }, "/api/metric/PollingAssignments/readInstances":{ "get":{ "tags":[ "Metrics/Polling Assignments" ], "summary":"Get Polling Assignment Instances", "description":"Gets the polling assignment instances that match the specified query parameters. If no parameters are specified, all instances are returned.", "operationId":"metric::PollingAssignments::Read_byID", "parameters":[ { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/page" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/metricPollingAssignmentsReadInstances" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-PollingAssignments-readInstances-get", "x-filename-id":"api-metric-pollingassignments-readinstances-get" } }, "/api/metric/PollingAssignments":{ "post":{ "tags":[ "Metrics/Polling Assignments" ], "summary":"Create Metrics for Polling Assignments", "description":"Creates metrics that are needed for polling to start working within some applications.
The minimum required properties in the request body are:\n ", "operationId":"metric::PollingAssignments::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/metricPollingAssignments", "required":[ "MethodID", "PollerTemplateID", "ThresholdGroupID", "PollTime", "Instances" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-PollingAssignments-post", "x-filename-id":"api-metric-pollingassignments-post" } }, "/api/metric/PollingPolicies/{id}":{ "get":{ "tags":[ "Metrics/Polling Policies" ], "summary":"Get a Polling Policy", "description":"Gets the polling policy that matches the specified ID. The polling policy can be used by the Metric Poller Discovery scheduled job.", "operationId":"metric::PollingPolicies::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the polling policy to get.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "description":"The polling policy that matches the specified ID.", "items":{ "$ref":"#/components/schemas/metricPollingPoliciesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-PollingPolicies-{id}-get", "x-filename-id":"api-metric-pollingpolicies-id-get" }, "put":{ "tags":[ "Metrics/Polling Policies" ], "summary":"Update a Polling Policy", "description":"Updates the polling policy that matches the specified ID.", "operationId":"metric::PollingPolicies::update", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the polling policy to update.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/metricPollingPolicies" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "description":"The updated polling policy.", "items":{ "$ref":"#/components/schemas/metricPollingPoliciesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-PollingPolicies-{id}-put", "x-filename-id":"api-metric-pollingpolicies-id-put" }, "delete":{ "tags":[ "Metrics/Polling Policies" ], "summary":"Delete a Polling Policy", "description":"Deletes the polling policy that matches the specified ID.", "operationId":"metric::PollingPolicies::delete", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the polling policy to delete.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-PollingPolicies-{id}-delete", "x-filename-id":"api-metric-pollingpolicies-id-delete" } }, "/api/metric/PollingPolicies":{ "get":{ "tags":[ "Metrics/Polling Policies" ], "summary":"Get Polling Policies", "description":"Gets the polling policies that match the specified query parameters. If no parameters are specified, all polling policies are returned.", "operationId":"metric::PollingPolicies::read", "parameters":[ { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "description":"The polling policies that match the specified query parameters.", "items":{ "$ref":"#/components/schemas/metricPollingPoliciesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-PollingPolicies-get", "x-filename-id":"api-metric-pollingpolicies-get" }, "post":{ "tags":[ "Metrics/Polling Policies" ], "summary":"Create a Polling Policy", "description":"Creates a polling policy.
The minimum required properties in the request body are:\n ", "operationId":"metric::PollingPolicies::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/metricPollingPolicies", "required":[ "PolicyName", "IPRange", "CIDR", "DeviceMetaTypeID", "DeviceTypeCategoryID", "StatusID", "InstanceTypeID", "SysObjectID", "PollerTemplateID", "MethodID", "ThresholdGroupID", "DeviceNameMatchTypeID", "InstanceNameMatchTypeID", "DeviceTypeMatchTypeID", "MetaDataMatchTypeID", "PollTime" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "description":"The new polling policy.", "items":{ "$ref":"#/components/schemas/metricPollingPoliciesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-PollingPolicies-post", "x-filename-id":"api-metric-pollingpolicies-post" } }, "/api/metric/RetentionPolicies/readForSelect":{ "get":{ "tags":[ "Metrics/Retention Policies" ], "summary":"Get Retention Policies for Combo Boxes and Item Selectors", "description":"Gets the retention policies that match the specified query parameters in a format suitable for combo boxes and item selectors. If no parameters are specified, all retention policies are returned.", "operationId":"metric::RetentionPolicies::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "description":"The retention policies that match the specified query parameters.", "items":{ "$ref":"#/components/schemas/metricRetentionPoliciesReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-RetentionPolicies-readForSelect-get", "x-filename-id":"api-metric-retentionpolicies-readforselect-get" } }, "/api/metric/ThresholdFunctions/readForSelect":{ "get":{ "tags":[ "Metrics/Threshold Functions" ], "summary":"Get Threshold Functions for Combo Boxes and Item Selectors", "description":"Gets the threshold functions that match the specified query parameters in a format suitable for combo boxes and item selectors. If no parameters are specified, all threshold functions are returned.", "operationId":"metric::ThresholdFunctions::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "description":"The threshold functions that match the specified query parameters.", "items":{ "$ref":"#/components/schemas/metricThresholdFunctionsReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-ThresholdFunctions-readForSelect-get", "x-filename-id":"api-metric-thresholdfunctions-readforselect-get" } }, "/api/metric/ThresholdGroups/{id}":{ "get":{ "tags":[ "Metrics/Threshold Groups" ], "summary":"Get a Metric Threshold Group", "description":"Gets the metric threshold group that matches the specified ID.", "operationId":"metric::ThresholdGroups::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the threshold group to get.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "description":"The metric threshold group that matches the specified ID.", "items":{ "$ref":"#/components/schemas/metricThresholdGroupsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-ThresholdGroups-{id}-get", "x-filename-id":"api-metric-thresholdgroups-id-get" }, "put":{ "tags":[ "Metrics/Threshold Groups" ], "summary":"Update a Metric Threshold Group", "description":"Updates the metric threshold group that matches the specified ID.", "operationId":"metric::ThresholdGroups::update", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the threshold group to update.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/metricThresholdGroups" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "description":"The updated metric threshold group.", "items":{ "$ref":"#/components/schemas/metricThresholdGroupsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-ThresholdGroups-{id}-put", "x-filename-id":"api-metric-thresholdgroups-id-put" }, "delete":{ "tags":[ "Metrics/Threshold Groups" ], "summary":"Delete a Metric Threshold Group", "description":"Deletes the metric threshold group that matches the specified ID.", "operationId":"metric::ThresholdGroups::delete", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the metric threshold group to delete.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-ThresholdGroups-{id}-delete", "x-filename-id":"api-metric-thresholdgroups-id-delete" } }, "/api/metric/ThresholdGroups":{ "get":{ "tags":[ "Metrics/Threshold Groups" ], "summary":"Get Metric Threshold Groups", "description":"Gets the metric threshold groups that match the specified query parameters. If no parameters are specified, all metric threshold groups are returned.", "operationId":"metric::ThresholdGroups::read", "parameters":[ { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "description":"The metric threshold groups that match the specified query parameters.", "items":{ "$ref":"#/components/schemas/metricThresholdGroupsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-ThresholdGroups-get", "x-filename-id":"api-metric-thresholdgroups-get" }, "post":{ "tags":[ "Metrics/Threshold Groups" ], "summary":"Create a Metric Threshold Group", "description":"Creates a metric threshold group.
The minimum required properties in the request body are:\n ", "operationId":"metric::ThresholdGroups::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/metricThresholdGroups", "required":[ "ThresholdGroupName", "Thresholds" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "description":"The new metric threshold group.", "items":{ "$ref":"#/components/schemas/metricThresholdGroupsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-ThresholdGroups-post", "x-filename-id":"api-metric-thresholdgroups-post" } }, "/api/metric/ThresholdGroups/readForSelect":{ "get":{ "tags":[ "Metrics/Threshold Groups" ], "summary":"Get Metric Threshold Groups for Combo Boxes and Item Selectors", "description":"Gets the metric threshold groups that match the specified query parameters in a format suitable for combo boxes and item selectors. If no parameters are specified, all metric threshold groups are returned.", "operationId":"metric::ThresholdGroups::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "description":"The metric threshold groups that match the specified query parameters.", "items":{ "$ref":"#/components/schemas/metricThresholdGroupsReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-ThresholdGroups-readForSelect-get", "x-filename-id":"api-metric-thresholdgroups-readforselect-get" } }, "/api/metric/Thresholds/{id}":{ "get":{ "tags":[ "Metrics/Metric Thresholds" ], "summary":"Get a Metric Threshold", "description":"Gets the metric threshold that matches the specified ID.", "operationId":"metric::Thresholds::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the metric threshold to get.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "description":"The metric threshold that matches the specified ID.", "items":{ "$ref":"#/components/schemas/metricThresholdsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Thresholds-{id}-get", "x-filename-id":"api-metric-thresholds-id-get" }, "put":{ "tags":[ "Metrics/Metric Thresholds" ], "summary":"Update a Metric Threshold", "description":"Updates the metric threshold that matches the specified ID.", "operationId":"metric::Thresholds::update", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the metric threshold to update.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/metricThresholds" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging", "type":"integer", "example":"1" }, "data":{ "type":"array", "description":"The updated metric threshold.", "items":{ "$ref":"#/components/schemas/metricThresholdsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Thresholds-{id}-put", "x-filename-id":"api-metric-thresholds-id-put" }, "delete":{ "tags":[ "Metrics/Metric Thresholds" ], "summary":"Delete a Metric Threshold", "description":"Deletes the metric threshold that matches the specified ID.", "operationId":"metric::Thresholds::delete", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the metric threshold to update.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Thresholds-{id}-delete", "x-filename-id":"api-metric-thresholds-id-delete" } }, "/api/metric/Thresholds":{ "get":{ "tags":[ "Metrics/Metric Thresholds" ], "summary":"Get Metric Thresholds", "description":"Gets the metric thresholds that match the specified query parameters. If no parameters are specified, all metric thresholds are returned.", "operationId":"metric::Thresholds::read", "parameters":[ { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging", "type":"integer", "example":"1" }, "data":{ "type":"array", "description":"The metric thresholds that match the specified query parameters.", "items":{ "$ref":"#/components/schemas/metricThresholdsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Thresholds-get", "x-filename-id":"api-metric-thresholds-get" }, "post":{ "tags":[ "Metrics/Metric Thresholds" ], "summary":"Create a Metric Threshold", "description":"Creates a metric threshold.
The minimum required properties in the request body are:\n ", "operationId":"metric::Thresholds::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/metricThresholds", "required":[ "Message", "Measurement", "TimeRange", "MetricField", "StatusID", "ThresholdName", "ThresholdTypeID", "ThresholdFunctionID" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "description":"The new metric threshold.", "items":{ "$ref":"#/components/schemas/metricThresholdsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Thresholds-post", "x-filename-id":"api-metric-thresholds-post" } }, "/api/metric/Thresholds/readForSelect":{ "get":{ "tags":[ "Metrics/Metric Thresholds" ], "summary":"Get Metric Thresholds for Combo Boxes and Item Selectors", "description":"Gets the metric thresholds that match the specified query parameters in a format suitable for combo boxes and item selectors. If no parameters are specified, all metric thresholds are returned.", "operationId":"metric::Thresholds::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "description":"The metric thresholds that match the specified query parameters.", "items":{ "$ref":"#/components/schemas/metricThresholdsReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Thresholds-readForSelect-get", "x-filename-id":"api-metric-thresholds-readforselect-get" } }, "/api/metric/ThresholdTypes/readForSelect":{ "get":{ "tags":[ "Metrics/Metric Threshold Types" ], "summary":"Get Metric Threshold Types for Combo Boxes and Item Selectors", "description":"Gets the metric threshold types that match the specified query parameters in a format suitable for combo boxes and item selectors. If no parameters are specified, all metric threshold types are returned.", "operationId":"metric::ThresholdTypes::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "description":"The metric threshold types that match the specified query parameters.", "items":{ "$ref":"#/components/schemas/metricThresholdTypesReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-ThresholdTypes-readForSelect-get", "x-filename-id":"api-metric-thresholdtypes-readforselect-get" } }, "/api/metric/TopNData":{ "get":{ "tags":[ "Metrics/TopN Data" ], "summary":"Get TopN Overview Data", "description":"Gets the TopN overview data for the objects specified in the query parameters.", "operationId":"metric::TopNData::Read", "parameters":[ { "name":"DeviceGroup", "in":"query", "description":"The device group to get TopN overview data for.", "required":true, "schema":{ "type":"string" }, "example":"//Root//Oracle Lab - test" }, { "name":"MetricGroupID", "in":"query", "description":"The ID of the metric group to get TopN overview data for.", "required":true, "schema":{ "type":"integer" }, "example":0 }, { "name":"MetricTypeID", "in":"query", "description":"The ID of the metric type to get TopN overview data for.", "required":true, "schema":{ "type":"integer" }, "example":0 }, { "name":"TimeRange", "in":"query", "description":"A shorthand string that encompasses StartTime and StopTime. Overwrites any value set for StartTime and StopTime.", "schema":{ "allOf":[ { "$ref":"#/components/parameters/TimeRange" } ] } }, { "name":"PageSize", "in":"query", "description":"The number of records to include per page.", "required":true, "schema":{ "type":"integer" }, "example":10 }, { "name":"StartTime", "in":"query", "description":"Start Time", "schema":{ "allOf":[ { "$ref":"#/components/parameters/StartTime" } ] } }, { "name":"StopTime", "in":"query", "description":"Stop Time", "schema":{ "allOf":[ { "$ref":"#/components/parameters/StopTime" } ] } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging", "type":"integer", "example":"1" }, "data":{ "description":"Each element is a different data set described by the title.", "type":"array", "items":{ "$ref":"#/components/schemas/metricTopNDataRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-TopNData-get", "x-filename-id":"api-metric-topndata-get" } }, "/api/metric/TopNData/readTitle":{ "get":{ "tags":[ "Metrics/TopN Data" ], "summary":"Get the TopN Overview Title", "description":"Gets the TopN overview title the objects specified in the query parameters.", "operationId":"metric::TopNData::readTitle", "parameters":[ { "name":"DeviceGroupID", "in":"query", "description":"The ID of the device group to get the TopN overview title for.", "required":true, "schema":{ "type":"integer" }, "example":7 }, { "name":"MetricGroupID", "in":"query", "description":"The ID of the metric group to get the TopN overview title for.", "required":true, "schema":{ "type":"integer" }, "example":1 }, { "name":"MetricTypeID", "in":"query", "description":"The ID of the metric type to get the TopN overview title for.", "required":true, "schema":{ "type":"integer" }, "example":1 }, { "name":"PageSize", "in":"query", "description":"The number of records to include per page.", "required":true, "schema":{ "type":"integer" }, "example":10 }, { "name":"BaseName", "in":"query", "description":"A custom portion of the title displayed between the \"Top-N\" and the details of what is being displayed.", "required":true, "schema":{ "type":"string" }, "example":"" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "description":"The TopN overview title.", "items":{ "$ref":"#/components/schemas/metricTopNDataReadTitle" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-TopNData-readTitle-get", "x-filename-id":"api-metric-topndata-readtitle-get" } }, "/api/metric/Transactions/{id}":{ "get":{ "tags":[ "Metrics/Metric Transactions" ], "summary":"Get a Metric Transaction", "description":"Gets the metric transaction that matches the specified ID.", "operationId":"metric::Transactions::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the transaction to get.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "description":"The metric transaction that matches the specified ID.", "items":{ "$ref":"#/components/schemas/metricTransactionsRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Transactions-{id}-get", "x-filename-id":"api-metric-transactions-id-get" }, "put":{ "tags":[ "Metrics/Metric Transactions" ], "summary":"Update a Metric Transaction", "description":"Updates the metric transaction that matches the specified ID.", "operationId":"metric::Transactions::update", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the metric transaction to update.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/metricTransactions" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "description":"The updated metric transaction.", "items":{ "$ref":"#/components/schemas/metricTransactionsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Transactions-{id}-put", "x-filename-id":"api-metric-transactions-id-put" }, "delete":{ "tags":[ "Metrics/Metric Transactions" ], "summary":"Delete a Metric Transaction", "description":"Deletes the metric transaction that matches the specified ID.", "operationId":"metric::Transactions::delete", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the metric transaction to delete.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Transactions-{id}-delete", "x-filename-id":"api-metric-transactions-id-delete" } }, "/api/metric/Transactions":{ "get":{ "tags":[ "Metrics/Metric Transactions" ], "summary":"Get Metric Transactions", "description":"Gets the metric transactions that match the specified query parameters. If no parameters are specified, all metric transactions are returned.", "operationId":"metric::Transactions::Read", "parameters":[ { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "description":"The metric transactions that match the specified query parameters.", "items":{ "$ref":"#/components/schemas/metricTransactionsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Transactions-get", "x-filename-id":"api-metric-transactions-get" }, "post":{ "tags":[ "Metrics/Metric Transactions" ], "summary":"Create a Metric Transaction", "description":"Creates a metric transaction.
The minimum required properties in the request body are:\n ", "operationId":"metric::Transactions::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/metricTransactions", "required":[ "TransactionName", "TransactionStatusID", "MetricTypeID" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "description":"The new metric transaction.", "items":{ "$ref":"#/components/schemas/metricTransactionsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Transactions-post", "x-filename-id":"api-metric-transactions-post" } }, "/api/metric/Transactions/readForSelect":{ "get":{ "tags":[ "Metrics/Metric Transactions" ], "summary":"Get Metric Transactions for Combo Boxes and Item Selectors", "description":"Gets the metric transactions that match the specified query parameters in a format suitable for combo boxes and item selectors. If no parameters are specified, all metric transactions are returned.", "operationId":"metric::Transactions::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "description":"The metric transactions that match the specified query parameters.", "items":{ "$ref":"#/components/schemas/metricTransactionsReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Transactions-readForSelect-get", "x-filename-id":"api-metric-transactions-readforselect-get" } }, "/api/metric/Transactions/executeCheckSyntax":{ "post":{ "tags":[ "Metrics/Metric Transactions" ], "summary":"Check Syntax for a Metric Transaction", "description":"Runs the transaction file provided in the request body through the CheckSyntax utility and returns the result. The Content property is required in the request body.", "operationId":"metric::Transactions::executeCheckSyntax", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/metricTransactionsExecuteCheckSyntax" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Success or failure response", "type":"boolean", "example":"true" }, "message":{ "description":"Response message in text.", "type":"string", "example":"Syntax Check OK" } }, "type":"object" } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Transactions-executeCheckSyntax-post", "x-filename-id":"api-metric-transactions-executechecksyntax-post" } }, "/api/metric/Types/{id}":{ "get":{ "tags":[ "Metrics/Metric Types" ], "summary":"Get a Metric Type", "description":"Gets the metric type that matches the specified ID.", "operationId":"metric::Types::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the metric type to get.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "description":"The metric type that matches the specified ID.", "items":{ "$ref":"#/components/schemas/metricTypesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Types-{id}-get", "x-filename-id":"api-metric-types-id-get" }, "put":{ "tags":[ "Metrics/Metric Types" ], "summary":"Update a Metric Type", "description":"Updates the metric type that matches the specified ID.", "operationId":"metric::Types::update", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the metric type to update.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/metricTypes" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "description":"The updated metric type.", "items":{ "$ref":"#/components/schemas/metricTypesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Types-{id}-put", "x-filename-id":"api-metric-types-id-put" }, "delete":{ "tags":[ "Metrics/Metric Types" ], "summary":"Delete a Metric Type", "description":"Deletes the metric type that matches the specified ID.", "operationId":"metric::Types::delete", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the metric type to delete.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Types-{id}-delete", "x-filename-id":"api-metric-types-id-delete" } }, "/api/metric/Types":{ "get":{ "tags":[ "Metrics/Metric Types" ], "summary":"Get Metric Types", "description":"Gets the metric types that match the specified query parameters. If no parameters are specified, all metric types are returned.", "operationId":"metric::Types::read", "parameters":[ { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "description":"The metric types that match the specified query parameters.", "items":{ "$ref":"#/components/schemas/metricTypesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Types-get", "x-filename-id":"api-metric-types-get" }, "post":{ "tags":[ "Metrics/Metric Types" ], "summary":"Create a Metric Type", "description":"Creates a metric type.
The minimum required properties in the request body are:\n ", "operationId":"metric::Types::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/metricTypes", "required":[ "MetricTypeName", "Unit", "Abbr", "ValueType", "MetricGroupID", "FormatID", "Direction", "TopNTypeID", "TopNScopeID", "UnitDivisionID" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "description":"The new metric type.", "items":{ "$ref":"#/components/schemas/metricTypesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Types-post", "x-filename-id":"api-metric-types-post" } }, "/api/metric/Types/readForSelect":{ "get":{ "tags":[ "Metrics/Metric Types" ], "summary":"Get Metric Types for Combo Boxes and Item Selectors", "description":"Gets the metric types that match the specified query parameters in a format suitable for combo boxes and item selectors. If no parameters are specified, all metric types are returned.", "operationId":"metric::Types::readForSelect", "parameters":[ { "name":"id", "in":"query", "description":"The ID of the metric type to get.", "schema":{ "type":"integer", "format":"int32" }, "example":1 }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "description":"The metric types that match the specified query parameters.", "items":{ "$ref":"#/components/schemas/metricTypesReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-metric-Types-readForSelect-get", "x-filename-id":"api-metric-types-readforselect-get" } }, "/api/microservice/Catalogs":{ "get":{ "tags":[ "Microservice/Helm Chart Catalog" ], "summary":"Get Available Helm Charts", "description":"Gets the available Helm charts for installation. The response includes the version, description, and released date.", "operationId":"microservice::Catalogs:read", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the request was successful (true) or not (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message.", "type":"string", "example":"Retrieved contents of helm index.yaml" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/microserviceCatalogsRead" } } } } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-microservice-Catalogs-get", "x-filename-id":"api-microservice-catalogs-get" } }, "/api/microservice/Catalogs/readForVersions":{ "get":{ "tags":[ "Microservice/Helm Chart Catalog" ], "summary":"Get Helm Chart Versions", "description":"Gets the versions for a specific Helm chart that match the specified parameters. If no parameters are specified, all versions are returned. Versions are returned in reverse chronological order.", "operationId":"microservice::Catalogs::readForVersions", "parameters":[ { "name":"Helmchart", "in":"query", "description":"The name of the Helm chart package.", "required":true, "schema":{ "type":"string" }, "example":"example-poller" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/microserviceCatalogsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-microservice-Catalogs-readForVersions-get", "x-filename-id":"api-microservice-catalogs-readforversions-get" } }, "/api/microservice/Catalogs/readForVersionsDetails":{ "get":{ "tags":[ "Microservice/Helm Chart Catalog" ], "summary":"Get Details of a Version of a Helm Chart", "description":"Gets details of a specific version of a Helm chart. Returns the chart version, description, release date, default value settings (values.yaml), and documentation (Readme.md if available).", "operationId":"microservice::Catalogs::readForVersionsDetails", "parameters":[ { "name":"Helmchart", "in":"query", "description":"The name of the Helm chart package.", "required":true, "schema":{ "type":"string" }, "example":"example-poller" }, { "name":"Version", "in":"query", "description":"The version of the Helm chart.", "required":true, "schema":{ "type":"string" }, "example":"6.0.3" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "allOf":[ { "$ref":"#/components/schemas/microserviceCatalogsRead" }, { "type":"object", "properties":{ "notes":{ "description":"The Notes.txt stores a list of available versions.", "type":"string", "example":"\"Default values for goexample./n/nreplicaCount: 1/n/nglobal:/n\"" }, "readme":{ "type":"string", "example":null, "nullable":true } } } ] } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-microservice-Catalogs-readForVersionsDetails-get", "x-filename-id":"api-microservice-catalogs-readforversionsdetails-get" } }, "/api/microservice/Catalogs/readForHelmchartValues":{ "get":{ "tags":[ "Microservice/Helm Chart Catalog" ], "summary":"Get Default Settings for a Helm Chart Repository", "description":"Gets the default values settings from the values.yaml for the specified Helm chart.", "operationId":"microservice::Catalogs::readForHelmchartValues", "parameters":[ { "name":"Helmchart", "in":"query", "description":"The name of the Helm chart package.", "required":true, "schema":{ "type":"string" }, "example":"example-poller" }, { "name":"Version", "in":"query", "description":"The version of the Helm chart.", "required":true, "schema":{ "type":"string" }, "example":"6.0.3" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "allOf":[ { "$ref":"#/components/schemas/microserviceCatalogsRead" }, { "type":"object", "properties":{ "customValues":{ "description":"The custom values for the Helm chart.", "type":"string", "example":"\"# Default values for example-poller/n/nglobal:/n imageRegistry: \"/\"/n/nreplicaCount: 1/n/nimage:/n registry: \"/\"/n repository: x/y\\n" } } } ] } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-microservice-Catalogs-readForHelmchartValues-get", "x-filename-id":"api-microservice-catalogs-readforhelmchartvalues-get" } }, "/api/microservice/Clusters":{ "get":{ "tags":[ "Microservice/Microservice Clusters" ], "summary":"Get Clusters", "description":"Gets the clusters that match the specified parameters. If no parameters are specified, all clusters are returned.", "operationId":"microservice::Clusters:read", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/microserviceClustersRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-microservice-Clusters-get", "x-filename-id":"api-microservice-clusters-get" } }, "/api/microservice/Clusters/readForServers":{ "get":{ "tags":[ "Microservice/Microservice Clusters" ], "summary":"Get Nodes and Their Roles within a Cluster", "description":"Gets the nodes and their roles within the clusters that match the specified parameters. If no parameters are specified, all nodes and their roles are returned.", "operationId":"microservice::Clusters:readForServers", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/microserviceClustersReadForServers" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-microservice-Clusters-readForServers-get", "x-filename-id":"api-microservice-clusters-readforservers-get" } }, "/api/microservice/Deploy":{ "get":{ "tags":[ "Microservice/Helm Deployment" ], "summary":"Get the Current Value Settings for a Helm Chart", "description":"Gets the current value settings for a Helm chart by Helm release name and version. You set values for installed Helm charts using the POST method on the /api/microservice/Deploy endpoint. Manually installing Helm charts with the a1helm binary will not preserve the value settings.", "operationId":"microservice::Deploy:read", "parameters":[ { "name":"Helmchart", "in":"query", "description":"The name of the Helm chart package.", "required":true, "schema":{ "type":"string" }, "example":"example-poller" }, { "name":"Version", "in":"query", "description":"The version of the Helm chart.", "required":true, "schema":{ "type":"string" }, "example":"6.0.3" }, { "name":"Cluster", "in":"query", "description":"The name of the cluster.", "required":true, "schema":{ "type":"string" }, "example":"cluster-1" }, { "name":"Namespace", "in":"query", "description":"Logical grouping of resources within a cluster.", "required":true, "schema":{ "type":"string" }, "example":"kube-system" }, { "name":"ReleaseName", "in":"query", "description":"The release name for the installed Helm chart. Can be at most 53 characters and must pass this regex test: `[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*`", "required":true, "schema":{ "type":"string" }, "example":"example-poller-deploy" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or a failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message in text.", "type":"string", "example":"" }, "data":{ "description":"The values for the specified Helm chart.", "type":"array", "items":{ "$ref":"#/components/schemas/microserviceDeployRead" } } }, "type":"object" } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-microservice-Deploy-get", "x-filename-id":"api-microservice-deploy-get" }, "post":{ "tags":[ "Microservice/Helm Deployment" ], "summary":"Deploy a Helm Chart", "description":"Deploys a version of a Helm chart inside a cluster and namespace.
The minimum required properties in the request body are:\n ", "operationId":"microservice::Deploy:create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/microserviceDeployRead", "required":[ "Cluster", "Namespace", "Helmchart", "ReleaseName", "Version" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or a failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message.", "type":"array", "items":{ }, "example":[ "NAME: example-poller", "LAST DEPLOYED: Sat Oct 21 11:22:51 2023", "NAMESPACE: a1-management", "STATUS: deployed", "REVISION: 1", "TEST SUITE: None" ] }, "data":{ "description":"Records array", "type":"array", "items":{ }, "example":[ [ "Service", "example-poller" ], [ "Deployment", "example-poller" ] ] } }, "type":"object" } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-microservice-Deploy-post", "x-filename-id":"api-microservice-deploy-post" } }, "/api/microservice/Deploy/readForReleaseName":{ "get":{ "tags":[ "Microservice/Helm Deployment" ], "summary":"Get Helm Release Names for a Helm Chart", "description":"Get all current Helm release names for an installed version of a Helm chart running in a specific cluster and namespace.", "operationId":"microservice::Deploy:readForReleaseName", "parameters":[ { "name":"Helmchart", "in":"query", "description":"The name of the Helm chart package.", "required":true, "schema":{ "type":"string" }, "example":"example-poller" }, { "name":"Version", "in":"query", "description":"The version of the Helm chart.", "required":true, "schema":{ "type":"string" }, "example":"6.0.3" }, { "name":"cluster", "in":"query", "description":"The name of the cluster.", "required":true, "schema":{ "type":"string" }, "example":"cluster-1" }, { "name":"Namespace", "in":"query", "description":"Logical grouping of resources within a cluster.", "required":true, "schema":{ "type":"string" }, "example":"ingress-nginx" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or a failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message in text.", "type":"string", "example":"" }, "data":{ "description":"List of Helm release names for a Helm chart.", "type":"array", "items":{ "$ref":"#/components/schemas/microserviceDeployReadForReleaseName" } } }, "type":"object" } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-microservice-Deploy-readForReleaseName-get", "x-filename-id":"api-microservice-deploy-readforreleasename-get" } }, "/api/microservice/Deploy/readClusterData":{ "get":{ "tags":[ "Microservice/Helm Deployment" ], "summary":"Get Namespaces for a Cluster", "description":"Get the list of namespaces that belong to the specified cluster.", "operationId":"microservice::Deploy:readClusterData", "parameters":[ { "name":"Cluster", "in":"query", "description":"The name of the cluster.", "schema":{ "type":"string" }, "example":"cluster-1" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or a failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message in text.", "type":"string", "example":"" }, "data":{ "description":"The list of namespaces that belong to the cluster.", "type":"array", "items":{ "$ref":"#/components/schemas/microserviceDeployReadClusterData" } } }, "type":"object" } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-microservice-Deploy-readClusterData-get", "x-filename-id":"api-microservice-deploy-readclusterdata-get" } }, "/api/microservice/Deploy/readForInstalled":{ "get":{ "tags":[ "Microservice/Helm Deployment" ], "summary":"Get a List of Installed Helm Charts", "description":"Gets the installed Helm charts, their names, cluster, namespace, version, and status that match the specified parameters. If no parameters are specified, all Helm charts are returned.", "operationId":"microservice::Deploy:readForServers", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or a failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message in text.", "type":"string", "example":"Retrieved installed helm charts from cluster(s)." }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/microserviceDeployReadForInstalled" } } } } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-microservice-Deploy-readForInstalled-get", "x-filename-id":"api-microservice-deploy-readforinstalled-get" } }, "/api/microservice/Deploy/{id}":{ "delete":{ "tags":[ "Microservice/Helm Deployment" ], "summary":"Uninstall Helm Chart", "description":"Uninstalls a Helm chart.", "operationId":"microservice::Deploy::delete", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the Helm chart to uninstall in the format release-name-=-cluster-name-=-namespace. Use -=- as a separator.", "required":true, "schema":{ "type":"string" }, "example":"id-example-poller-=-a1-cache-=-cluster-1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or a failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message in text.", "type":"string", "example":"Uninstalled helm chart." } } } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-microservice-Deploy-{id}-delete", "x-filename-id":"api-microservice-deploy-id-delete" } }, "/api/microservice/Workload/readForTree":{ "get":{ "tags":[ "Microservice/Kubernetes Workload" ], "summary":"Get Microservice Workloads for a Tree Grids", "description":"Gets microservice workloads in a format suitable for tree grids.", "operationId":"microservice::Workload::readForTree", "parameters":[ { "name":"node", "in":"query", "description":"The node to start the tree. The response depends on this parameter as follows:\n", "schema":{ "type":"string" }, "examples":{ "example1":{ "value":"root" }, "example2":{ "value":"/cluster-1" }, "example3":{ "value":"/cluster-1/a1-management & type=pod" } } }, { "name":"type", "in":"query", "description":"The type of workload. This parameter is only used if the value of the node parameter is a namespace, /{cluster}/{namespace} format.\nPossible values are pod, deployment, service, statefulset, job, replicaset, daemonset, and cronjob.", "schema":{ "type":"string" }, "example":"cronjob" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/microserviceWorkloadReadForTree" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-microservice-Workload-readForTree-get", "x-filename-id":"api-microservice-workload-readfortree-get" } }, "/api/microservice/Workload/readLogs":{ "get":{ "tags":[ "Microservice/Kubernetes Workload" ], "summary":"Get Microservice Container Logs", "description":"Gets microservice container logs. For performance reasons, only the last 20 lines of logs are returned.", "operationId":"microservice::Workload::readLogs", "parameters":[ { "name":"path", "in":"query", "description":"The resource path, in /{cluster}/{namespace}/{resource-name} format.", "required":true, "schema":{ "type":"string" }, "example":"/cluster-1/kube-system/canal" }, { "name":"workloadType", "in":"query", "description":"The type of the workload. Possible values are pod, deployment, service, statefulset, job, replicaset, daemonset, or cronjob.", "required":true, "schema":{ "type":"string" }, "example":"daemonset" }, { "name":"container", "in":"query", "description":"The microservice init-container or the container ID.", "schema":{ "type":"string" }, "example":"" }, { "name":"TimestampPrefix", "in":"query", "description":"The time stamp prefix which is used to show time stamps. If time stamp prefix is 1, log timestamp is included in the results.", "schema":{ "type":"integer" }, "example":1 }, { "name":"ContainerPrefix", "in":"query", "description":"The container prefix which is used to get container data. If container prefix is 1, source container name is included in the results.", "schema":{ "type":"integer" }, "example":1 }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or a failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message in text.", "type":"string", "example":"" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/microserviceWorkloadReadLogs" } } } } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-microservice-Workload-readLogs-get", "x-filename-id":"api-microservice-workload-readlogs-get" } }, "/api/microservice/Workload/readForPodDetails":{ "get":{ "tags":[ "Microservice/Kubernetes Workload" ], "summary":"Get Details for a Running Pod", "description":"Gets the details for the pod running at the specified path.", "operationId":"microservice::Workload::readForPodDetails", "parameters":[ { "name":"path", "in":"query", "description":"The full path, in /{cluster}/{namespace}/{pod-name} format.", "required":true, "schema":{ "type":"string" }, "example":"/cluster-1/a1-cache/example-poller-5749c48df5-2mcpv" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or a failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message in text.", "type":"string", "example":"" }, "data":{ "description":"Returns a subset of Kubernetes pod details. For full details, you can use the following command:\na1k -n {namespace} -ojson get pod {pod-id}", "type":"object", "example":{ "Labels":{ "Labels Details":"Value", "Annotations":{ "Annotations Details":"Value" }, "IP":"10.42.0.8", "IPs":[ { "ip":"10.42.0.8" } ], "StartTime":"2023-08-04T10:59:14Z", "Conditions":[ { "lastProbeTime":null, "lastTransitionTime":"2023-08-04T10:59:14Z", "status":"True", "type":"Initialized" } ], "Tolerations":[ { "effect":"NoExecute", "key":"node.kubernetes.io/not-ready", "operator":"Exists", "tolerationSeconds":300 } ], "Node":"router.example.com", "Priority":0, "PriorityName":null, "QoS":"BestEffort", "Status":"Running", "Owner":"ReplicaSet/pod-presets-webhook-66bcf77944", "NodeSelector":null, "InitContainers":[ ], "Containers":{ "Container Details":"Value", "Mounts":[ { "mountPath":"/certs/a1", "name":"a1-certs", "readOnly":true } ], "Command":null, "Args":null, "EnvVar":[ { "name":"WEBHOOK_PORT", "value":"8443" }, { "name":"DIRECTORY", "value":"/Directorypath" }, { "name":"CLUSTER_NAME", "value":"cluster-1" } ], "Liveness":null, "Readiness":null, "Request":null, "Ports":[ { "containerPort":8443, "protocol":"TCP" } ], "Volumes":null } }, "Volumes":{ "a1-certs":"secret", "ns-cert":"secret", "a1-config":"[configMap] a1-config" }, "Events":[ ] } } } } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-microservice-Workload-readForPodDetails-get", "x-filename-id":"api-microservice-workload-readforpoddetails-get" } }, "/api/microservice/Workload/readForDeploymentDetails":{ "get":{ "tags":[ "Microservice/Kubernetes Workload" ], "summary":"Get Details for a Running Deployment", "description":"Gets the details for the deployment running at the specified path.", "operationId":"microservice::Workload::readForDeploymentDetails", "parameters":[ { "name":"path", "in":"query", "description":"The full path, in /{cluster}/{namespace}/{deployment-name} format.", "required":true, "schema":{ "type":"string" }, "example":"/cluster-1/a1-cache/example-poller" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or a failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message in text.", "type":"string", "example":"" }, "data":{ "description":"Returns a subset of Kubernetes deployment details. For full details, you can use the following command:\na1k -n {namespace} -ojson get deployment {deployment-id}", "type":"object", "example":{ "Annotations":{ "Annotations Details":"Value", "Name":"example-poller", "Namespace":"a1-cache", "Created":"2023-10-21T11:20:46Z", "Conditions":[ { "lastTransitionTime":"2023-10-21T11:20:46Z", "lastUpdateTime":"2023-10-21T11:20:47Z", "message":"ReplicaSet \"example-poller-5749c48df5\" has successfully progressed.", "reason":"NewReplicaSetAvailable", "status":"True", "type":"Progressing" } ], "Replicas":1, "StrategyType":"RollingUpdate", "Selector":{ "Selector Details":"Value" }, "Labels":{ "Labels Details":"Value" }, "Tolerations":null, "CPU":[ ], "Memory":[ ], "Events":[ ], "Pods":{ "Pod Details":"Value" } } } } } } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-microservice-Workload-readForDeploymentDetails-get", "x-filename-id":"api-microservice-workload-readfordeploymentdetails-get" } }, "/api/microservice/Workload/readForReplicaSetDetails":{ "get":{ "tags":[ "Microservice/Kubernetes Workload" ], "summary":"Get Details for a Running Replicaset", "description":"Gets the details for the replicaset running at the specified path.", "operationId":"microservice::Workload::readForReplicaSetDetails", "parameters":[ { "name":"path", "in":"query", "description":"The full path, in /{cluster}/{namespace}/{replicaset-name} format.", "required":true, "schema":{ "type":"string" }, "example":"/cluster-1/a1-cache/example-poller-5749c48df5" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or a failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message in text.", "type":"string", "example":"" }, "data":{ "description":"Returns a subset of Kubernetes replicaSet details. For full details, you can use the following command:\na1k -n {namespace} -ojson get replicaset {replicaset-id}", "type":"object", "example":{ "Created":"2023-10-21T11:20:46Z", "Annotations":{ "Annotations Details":"Value" }, "Name":"example-poller-5749c48df5", "Namespace":"a1-cache", "Labels":{ "Labels Details":"Value" }, "Conditions":null, "Replicas":1, "Selector":{ "Selector Details":"Value" }, "NodeSelector":null, "Tolerations":null, "Images":[ "router.example.com/assure1/example-poller:v6.0.3-0.0.54" ], "ControlledBy":[ "Deployment/example-poller" ], "Events":[ ], "Pods":{ "Pod Details":"Value" } } } } } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-microservice-Workload-readForReplicaSetDetails-get", "x-filename-id":"api-microservice-workload-readforreplicasetdetails-get" } }, "/api/microservice/Workload/readForDaemonSetDetails":{ "get":{ "tags":[ "Microservice/Kubernetes Workload" ], "summary":"Get Details for a Running Daemonset", "description":"Gets the details for the daemonset running at the specified path.", "operationId":"microservice::Workload::readForDaemonSetDetails", "parameters":[ { "name":"path", "in":"query", "description":"The full path, in /{cluster}/{namespace}/{daemonset-name} format.", "required":true, "schema":{ "type":"string" }, "example":"/cluster-1/a1-cache/example-poller" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or a failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message in text.", "type":"string", "example":"" }, "data":{ "description":"Returns a subset of Kubernetes daemonSet details. For full details, you can use the following command:\na1k -n {namespace} -ojson get daemonset {daemonset-id}", "type":"object", "example":{ "Annotations":{ "Annotations Details":"Value", "Name":"example-poller", "Namespace":"a1-cache", "Created":"2023-10-21T11:20:46Z", "Conditions":[ { "lastTransitionTime":"2023-10-21T11:20:46Z", "lastUpdateTime":"2023-10-21T11:20:47Z", "message":"ReplicaSet \"example-poller-5749c48df5\" has successfully progressed.", "reason":"NewReplicaSetAvailable", "status":"True", "type":"Progressing" } ], "Replicas":1, "StrategyType":"RollingUpdate", "Selector":{ "Selector Details":"Value" }, "Labels":{ "Labels Details":"Value" }, "Tolerations":null, "CPU":[ ], "Memory":[ ], "Events":[ ], "Pods":{ "Pod Details":"Value" } } } } } } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-microservice-Workload-readForDaemonSetDetails-get", "x-filename-id":"api-microservice-workload-readfordaemonsetdetails-get" } }, "/api/microservice/Workload/readForJobDetails":{ "get":{ "tags":[ "Microservice/Kubernetes Workload" ], "summary":"Get Details for a Running Job", "description":"Gets the details of the job running at the specified path.", "operationId":"microservice::Workload::readForJobDetails", "parameters":[ { "name":"path", "in":"query", "description":"The full path, in /{cluster}/{namespace}/{job-name} format.", "required":true, "schema":{ "type":"string" }, "example":"/cluster-1/a1-messaging/jobname" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or a failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message in text.", "type":"string", "example":"" }, "data":{ "description":"Returns a subset of Kubernetes job details. For full details, you can use the following command:\na1k -n {namespace} -ojson get job {job-id}", "type":"object", "example":{ "Name":"Job Name", "Namespace":"a1-messaging", "Created":"2023-08-04T11:02:30Z", "Conditions":[ { "lastProbeTime":"2023-08-04T11:03:35Z", "lastTransitionTime":"2023-08-04T11:03:35Z", "status":"True", "type":"Complete" } ], "Selector":{ "controller-uid":"b8741227-69e0-4314-8778-a4043e011725" }, "Labels":{ "Labels Details":"Value" }, "Tolerations":null, "Completions":1, "Parallelism":1, "CompleteAt":"2023-08-04T11:03:34Z", "Images":null, "Events":[ ], "Pods":{ "Pod Details":"Value" } } } } } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-microservice-Workload-readForJobDetails-get", "x-filename-id":"api-microservice-workload-readforjobdetails-get" } }, "/api/microservice/Workload/readForServiceDetails":{ "get":{ "tags":[ "Microservice/Kubernetes Workload" ], "summary":"Get Details for a Running Service", "description":"Gets the details for the service running at the specified path.", "operationId":"microservice::Workload::readForServiceDetails", "parameters":[ { "name":"path", "in":"query", "description":"The full path, in /{cluster}/{namespace}/{service-name} format.", "required":true, "schema":{ "type":"string" }, "example":"/cluster-1/a1-cache/servicename" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or a failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message in text.", "type":"string", "example":"" }, "data":{ "description":"Returns a subset of Kubernetes job details. For full details, you can use the following command:\na1k -n {namespace} -ojson get service {service-id}", "type":"object", "example":{ "Name":"example-poller", "Namespace":"a1-cache", "Created":"2023-10-21T11:20:46Z", "Selector":{ "Selector Details":"Value" }, "Labels":{ "Labels Details":"Value" }, "Annotations":{ "Annotations Details":"Value" }, "SessionAffinity":"None", "Type":"ClusterIP", "Images":[ ], "Events":[ ], "Pods":{ "Pod Details":"Value" } } } } } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-microservice-Workload-readForServiceDetails-get", "x-filename-id":"api-microservice-workload-readforservicedetails-get" } }, "/api/microservice/Workload/readForStatefulSetDetails":{ "get":{ "tags":[ "Microservice/Kubernetes Workload" ], "summary":"Get Details for a Statefulset", "description":"Gets the details for the statefulset running at the specified path.", "operationId":"microservice::Workload::readForStatefulSetDetails", "parameters":[ { "name":"path", "in":"query", "description":"The full path, in /{cluster}/{namespace}/{statefulset-name} format.", "required":true, "schema":{ "type":"string" }, "example":"/cluster-1/a1-messaging/servicename" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or a failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message in text.", "type":"string", "example":"" }, "data":{ "description":"Returns a subset of Kubernetes StatefulSetDetail details. For full details, you can use the following command:\n
\na1k -n {namespace} -ojson get statefulset {statefulset-id}", "type":"object", "example":{ "Name":"Service Name", "Created":"2023-08-04T11:02:30Z", "Selector":{ "Selector Details":"Value" }, "Labels":{ "Labels Details":"Value" }, "Annotations":{ "Annotations Details":"Value" }, "Images":null, "Events":[ ], "Pods":{ "Pod Details":"Value" } } } } } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-microservice-Workload-readForStatefulSetDetails-get", "x-filename-id":"api-microservice-workload-readforstatefulsetdetails-get" } }, "/api/microservice/Workload/readForCronJobDetails":{ "get":{ "tags":[ "Microservice/Kubernetes Workload" ], "summary":"Get Details for a Running Cronjob", "description":"Gets the details for the cronjob running at the specified path.", "operationId":"microservice::Workload::readForCronJobDetails", "parameters":[ { "name":"path", "in":"query", "description":"The full path, in /{cluster}/{namespace}/{cronjob-name} format.", "required":true, "schema":{ "type":"string" }, "example":"/cluster-1/a1-messaging/cronjob" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or a failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message in text.", "type":"string", "example":"" }, "data":{ "description":"Returns a subset of Kubernetes CronJob details. For full details, you can use the following command:\na1k -n {namespace} -ojson get cronjob {cronjob-id}", "type":"object", "example":{ "Name":"Job Name", "Namespace":"a1-messaging", "Created":"2023-08-04T11:02:30Z", "Annotations":{ "Annotations Details":"Value" }, "Schedule":null, "Suspend":null, "Events":[ ], "Pods":{ "Pod Details":"Value" } } } } } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-microservice-Workload-readForCronJobDetails-get", "x-filename-id":"api-microservice-workload-readforcronjobdetails-get" } }, "/api/navigation/Bookmarks":{ "get":{ "tags":[ "Navigation/Bookmarks" ], "summary":"Get a User's Bookmarks", "description":"Gets a list of the user's custom bookmarks for the navigation menus.", "operationId":"navigation::Bookmarks::read", "parameters":[ { "name":"UserID", "in":"query", "description":"The user ID. Bookmarks belong to a particular user.", "schema":{ "type":"integer", "format":"int32" }, "example":1 }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/navigationBookmarksRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-navigation-Bookmarks-get", "x-filename-id":"api-navigation-bookmarks-get" }, "post":{ "tags":[ "Navigation/Bookmarks" ], "summary":"Create a Bookmark for a User", "description":"Creates a user bookmark for the navigation menu. Users can bookmark links, such as the device overview dashboard of a monitored device or a diagram showing the status of reporting devices.
\n
The minimum required properties in the request body are:\n ", "operationId":"navigation::Bookmarks::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/navigationBookmarks", "required":[ "BookmarkName", "LinkPath", "UserID", "IconCls" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or a failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message in text.", "type":"string", "example":"Added bookmark" } }, "type":"object" } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-navigation-Bookmarks-post", "x-filename-id":"api-navigation-bookmarks-post" } }, "/api/navigation/Bookmarks/{id}":{ "put":{ "tags":[ "Navigation/Bookmarks" ], "summary":"Update a Bookmark", "description":"Updates the properties of an existing bookmark specified by the bookmark ID.", "operationId":"navigation::Bookmarks::update", "parameters":[ { "name":"id", "in":"path", "description":"The bookmark ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/navigationBookmarks" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or a failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message in text.", "type":"string", "example":"Updated record" } }, "type":"object" } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-navigation-Bookmarks-{id}-put", "x-filename-id":"api-navigation-bookmarks-id-put" }, "delete":{ "tags":[ "Navigation/Bookmarks" ], "summary":"Delete a Bookmark", "description":"Deletes a bookmark specified by the bookmark ID.", "operationId":"navigation::Bookmarks::delete", "parameters":[ { "name":"id", "in":"path", "description":"The bookmark ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-navigation-Bookmarks-{id}-delete", "x-filename-id":"api-navigation-bookmarks-id-delete" } }, "/api/navigation/Configurations/readKeywords":{ "get":{ "tags":[ "Navigation/Navigation Configurations" ], "summary":"Get a List of Search Keywords for Menu", "description":"Gets the list of search keywords for the menu.", "operationId":"navigation::Configurations::readKeywords", "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or a failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message in text.", "type":"string", "example":"" }, "data":{ "description":"Records", "type":"object", "example":{ "/#AAA/authTypes":"authentication,saml,ldap,sso,radius,active directory,security", "/#AAA/roles":"roles,user,acl,access control,aaa,rbac,security,permissions", "/#AAA/users":"users,accounts,password,operators", "/#AAA/userGroups":"users,groups,accounts,roles,properties,permissions,restrictions", "/#broker/applicationConfigTypes":"application,config,datatype,services,jobs", "/#broker/failoverStates":"servers,failover,service,state,status", "/#broker/jobs":"servers,jobs,scheduled,processes,scripts,logs,start", "/#broker/licenses":"license,licence,licensing", "/#package/depots":"packages,updates,upgrades,edge,stable,nightly", "/#broker/servers":"servers,updates,upgrades,versions,software,broker,roles", "/#broker/services":"servers,services,processes,scripts,running,applications,logs,stop,start,restart,pid", "/#dashboard/dashboards":"dashboards,portals,reports,panel", "/#dashboard/groups":"dashboards,portals,groups", "/#database/database":"databases,sql,mysql,neo4j,influx,query", "/#database/queries":"query,queries,databases,sql,reports", "/#database/queryTool":"query,queries,sql", "/#device/devices":"devices,catalog,inventory,discover", "/#device/groups":"groups,grouping,devices,category", "/#device/deviceManagement":"device,edit,multiple,management,bulk,change", "/#device/categories":"devices,types,categories,category,icon", "/#device/types":"devices,types,category,sysoid,oid,enterprise,vendor", "/#device/zones":"zones,devices", "/#device/windows":"maintenance,windows,devices,outage,mtce", "/#device/metaTypes":"devices,types,metatype,label,tagging", "/#device/vendors":"vendor,devices,types,category,categories" } } }, "type":"object" } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-navigation-Configurations-readKeywords-get", "x-filename-id":"api-navigation-configurations-readkeywords-get" } }, "/api/notification/Profiles":{ "get":{ "tags":[ "Notification/Notification Profiles" ], "summary":"Get Notification Profiles", "description":"Gets the notification profiles that match the specified parameters. If no parameters are specified, all notification profiles are returned.", "operationId":"notification::Profiles::read", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/notificationProfilesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-notification-Profiles-get", "x-filename-id":"api-notification-profiles-get" }, "post":{ "tags":[ "Notification/Notification Profiles" ], "summary":"Create a Notification Profile", "description":"Creates a new notification profile.
The minimum required properties in the request body are:\n ", "operationId":"notification::Profiles::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/notificationProfilesCreate", "required":[ "ProfileTypeID", "ProfileName" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/notificationProfilesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-notification-Profiles-post", "x-filename-id":"api-notification-profiles-post" } }, "/api/notification/Profiles/{id}":{ "get":{ "tags":[ "Notification/Notification Profiles" ], "summary":"Get a Notification Profile by ID", "description":"Gets the notification profile that matches the specified ID.", "operationId":"notification::Profiles::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The notification profile ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/notificationProfilesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-notification-Profiles-{id}-get", "x-filename-id":"api-notification-profiles-id-get" }, "delete":{ "tags":[ "Notification/Notification Profiles" ], "summary":"Delete a Profile by ID", "description":"Deletes the notification profile that matches the specified ID.", "operationId":"notification::Profiles::delete", "parameters":[ { "name":"id", "in":"path", "description":"The notification profile ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-notification-Profiles-{id}-delete", "x-filename-id":"api-notification-profiles-id-delete" }, "put":{ "tags":[ "Notification/Notification Profiles" ], "summary":"Update a Notification Profile by ID", "description":"Updates the properties of the specified notification profile.", "operationId":"notification::Profiles::update", "parameters":[ { "name":"id", "in":"path", "description":"The notification profile ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/notificationProfilesCreate" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/notificationProfilesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-notification-Profiles-{id}-put", "x-filename-id":"api-notification-profiles-id-put" } }, "/api/notification/Profiles/readForSelect":{ "get":{ "tags":[ "Notification/Notification Profiles" ], "summary":"Get Notification Profiles for Combo Boxes and Item Selectors", "description":"Gets notification profiles in a format suitable for combo boxes and item selectors.", "operationId":"notification::Profiles::readForSelect", "parameters":[ { "name":"id", "in":"query", "description":"Either the ProfileID (integer) or ProfileName (string) of the notification profile to get. Returns only results that match the specified ID exactly.", "required":false, "schema":{ "oneOf":[ { "type":"integer" }, { "type":"string" } ] }, "example":1 }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" }, { "name":"query", "in":"query", "description":"Query by similar match on ProfileName", "required":false, "schema":{ "type":"string" }, "example":"Generic Email" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/notificationProfilesReadForSelect" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-notification-Profiles-readForSelect-get", "x-filename-id":"api-notification-profiles-readforselect-get" } }, "/api/notification/Templates":{ "get":{ "tags":[ "Notification/Notification Templates" ], "summary":"Get Notification Templates", "description":"Gets the notification templates that match the specified parameters. If no parameters are specified, all notification templates are returned.", "operationId":"notification::Templates::read", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/notificationTemplatesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-notification-Templates-get", "x-filename-id":"api-notification-templates-get" }, "post":{ "tags":[ "Notification/Notification Templates" ], "summary":"Create a Notification Template", "description":"Creates a new notification template.
The minimum required properties in the request body are:\n ", "operationId":"notification::Templates::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/notificationTemplatesCreate" } ], "required":[ "ProfileTypeID", "TemplateName" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/notificationTemplatesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-notification-Templates-post", "x-filename-id":"api-notification-templates-post" } }, "/api/notification/Templates/{id}":{ "get":{ "tags":[ "Notification/Notification Templates" ], "summary":"Get a Template by ID", "description":"Gets the notification template that matches the specified ID.", "operationId":"notification::Templates::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The notification template ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/notificationTemplatesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-notification-Templates-{id}-get", "x-filename-id":"api-notification-templates-id-get" }, "delete":{ "tags":[ "Notification/Notification Templates" ], "summary":"Delete a Template by ID", "description":"Deletes the notification template that matches the specified ID.", "operationId":"notification::Templates::delete", "parameters":[ { "name":"id", "in":"path", "description":"The notification template ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-notification-Templates-{id}-delete", "x-filename-id":"api-notification-templates-id-delete" }, "put":{ "tags":[ "Notification/Notification Templates" ], "summary":"Update a Template by ID", "description":"Updates the properties of the notification template that matches the specified ID.", "operationId":"notification::Templates::update", "parameters":[ { "name":"id", "in":"path", "description":"The notification template ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/notificationTemplatesCreate" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/notificationTemplatesRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-notification-Templates-{id}-put", "x-filename-id":"api-notification-templates-id-put" } }, "/api/notification/Templates/readForSelect":{ "get":{ "tags":[ "Notification/Notification Templates" ], "summary":"Get Notification Templates for Combo Boxes and Item Selectors", "description":"Gets notification templates in a format suitable for combo boxes and item selectors.", "operationId":"notification::Templates::readForSelect", "parameters":[ { "name":"id", "in":"query", "description":"Either the TemplateID (integer) or TemplateName (string) of the notification template to get. Returns only results that match the specified ID exactly.", "required":false, "schema":{ "oneOf":[ { "type":"integer" }, { "type":"string" } ] } }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" }, { "name":"query", "in":"query", "description":"Query by similar match on TemplateName", "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/notificationTemplatesReadForSelect" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-notification-Templates-readForSelect-get", "x-filename-id":"api-notification-templates-readforselect-get" } }, "/api/package/Depots/{id}":{ "get":{ "tags":[ "Package/Package Depots" ], "summary":"Get a Depot by ID", "description":"Gets the depot that matches the specified ID.", "operationId":"package::Depots:Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The depot ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/packageDepotsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-package-Depots-{id}-get", "x-filename-id":"api-package-depots-id-get" }, "put":{ "tags":[ "Package/Package Depots" ], "summary":"Update a Depot", "description":"Updates the properties of an existing package depot specified by the depot ID.\n", "operationId":"package::Depots::update", "parameters":[ { "name":"id", "in":"path", "description":"The depot ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/packageDepots" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/packageDepotsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-package-Depots-{id}-put", "x-filename-id":"api-package-depots-id-put" }, "delete":{ "tags":[ "Package/Package Depots" ], "summary":"Delete a Depot", "description":"Deletes a package depot specified by the depot ID.", "operationId":"package::Depots::delete", "parameters":[ { "name":"id", "in":"path", "description":"The depot ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-package-Depots-{id}-delete", "x-filename-id":"api-package-depots-id-delete" } }, "/api/package/Depots":{ "get":{ "tags":[ "Package/Package Depots" ], "summary":"Get Depots", "description":"Gets a list of all depots and their attributes that match the specified parameters. If no parameters are specified, all depots along with their attributes are returned.", "operationId":"package::Depots:read", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/packageDepotsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-package-Depots-get", "x-filename-id":"api-package-depots-get" }, "post":{ "tags":[ "Package/Package Depots" ], "summary":"Create a Depot", "description":"Creates a new package depot.
The minimum required properties in the request body are:\n ", "operationId":"package::Depots:create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/packageDepots", "required":[ "DepotName", "StatusID", "DepotType", "DepotLocation" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/packageDepotsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-package-Depots-post", "x-filename-id":"api-package-depots-post" } }, "/api/package/Depots/readForSelect":{ "get":{ "tags":[ "Package/Package Depots" ], "summary":"Get Package Depots for Combo Boxes and Item Selectors", "description":"Gets package depots in a format suitable for combo boxes and item selectors.", "operationId":"package::Depots::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/packageDepotsReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-package-Depots-readForSelect-get", "x-filename-id":"api-package-depots-readforselect-get" } }, "/api/report/Reports/{id}":{ "get":{ "tags":[ "Report/Reports" ], "summary":"Get a Report by ID", "description":"Gets the report that matches the specified ID.", "operationId":"report::Reports::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The report ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/reportReportsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-report-Reports-{id}-get", "x-filename-id":"api-report-reports-id-get" }, "put":{ "tags":[ "Report/Reports" ], "summary":"Update a Report", "description":"Updates the properties of an existing report specified by the report ID.\n", "operationId":"report::Reports::update", "parameters":[ { "name":"id", "in":"path", "description":"The report ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/reportReports" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/reportReportsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-report-Reports-{id}-put", "x-filename-id":"api-report-reports-id-put" }, "delete":{ "tags":[ "Report/Reports" ], "summary":"Delete a Report", "description":"Deletes a report specified by the report ID.", "operationId":"report::Reports::delete", "parameters":[ { "name":"id", "in":"path", "description":"The report ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-report-Reports-{id}-delete", "x-filename-id":"api-report-reports-id-delete" } }, "/api/report/Reports":{ "get":{ "tags":[ "Report/Reports" ], "summary":"Get Reports", "description":"Gets a list of all reports and their attributes that match the specified parameters. If no parameters are specified, all reports and their attributes are returned.", "operationId":"report::Reports::read", "parameters":[ { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/reportReportsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-report-Reports-get", "x-filename-id":"api-report-reports-get" }, "post":{ "tags":[ "Report/Reports" ], "summary":"Create a Report", "description":"Creates a new report.
The minimum required properties in the request body are:\n \n", "operationId":"report::Reports::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/reportReports" } ], "required":[ "ReportName", "AppendDateTime", "DashboardID", "ReportProfileID", "RunAsUserID", "OwnerUserID", "OwnerUserGroupID", "StatusID", "ReportParameters", "Recipients", "Footer", "RenderTimeout", "Minutes", "Hours", "Days", "Months", "WeekDays" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/reportReportsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-report-Reports-post", "x-filename-id":"api-report-reports-post" } }, "/api/report/Reports/readForSelect":{ "get":{ "tags":[ "Report/Reports" ], "summary":"Get Reports for Combo Boxes and Item Selectors", "description":"Gets reports in a format suitable for combo boxes and item selectors.", "operationId":"report::Reports::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" }, { "name":"query", "in":"query", "description":"Query search by report name.", "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/reportReportsReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-report-Reports-readForSelect-get", "x-filename-id":"api-report-reports-readforselect-get" } }, "/api/report/Reports/executeStart":{ "get":{ "tags":[ "Report/Reports" ], "summary":"Start a Report", "description":"Starts a report.", "operationId":"report::Reports::executeStart", "parameters":[ { "name":"BrokerComponentID", "in":"query", "description":"The broker component that will carry out generation of the report.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":55 }, { "name":"ReportIDList", "in":"query", "description":"The comma separated list of report IDs requested for forced execution.", "required":true, "schema":{ "type":"string" }, "example":1000 } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Successful operation", "type":"boolean", "example":"true" }, "message":{ "description":"The response message in text.", "type":"string", "example":"Report succeeded" } }, "type":"object" } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-report-Reports-executeStart-get", "x-filename-id":"api-report-reports-executestart-get" } }, "/api/report/OpenSearch/readForSelect":{ "get":{ "tags":[ "Report/Reports" ], "summary":"Get OpenSearch Dashboards for Combo Boxes and Item Selectors", "description":"Gets a list of OpenSearch dashboards in a format suitable for combo boxes and item selectors, to use when generating reports. This endpoint does not support filtering parameters.", "operationId":"report::OpenSearch::readForSelect", "parameters":[ { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/reportOpenSearchReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-report-OpenSearch-readForSelect-get", "x-filename-id":"api-report-opensearch-readforselect-get" } }, "/api/report/Profiles/{id}":{ "get":{ "tags":[ "Report/Report Profiles" ], "summary":"Get a Report Profile by ID", "description":"Gets the profile that matches the specified ID.", "operationId":"report::Profiles::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The profile ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/reportProfilesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-report-Profiles-{id}-get", "x-filename-id":"api-report-profiles-id-get" }, "put":{ "tags":[ "Report/Report Profiles" ], "summary":"Update a Report Profile", "description":"Updates the properties of an existing report profile specified by the profile ID.\n", "operationId":"report::Profiles::update", "parameters":[ { "name":"id", "in":"path", "description":"The profile ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/reportProfiles" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/reportProfilesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-report-Profiles-{id}-put", "x-filename-id":"api-report-profiles-id-put" }, "delete":{ "tags":[ "Report/Report Profiles" ], "summary":"Delete a Report Profile", "description":"Deletes a report profile specified by the profile ID.", "operationId":"report::Profiles::delete", "parameters":[ { "name":"id", "in":"path", "description":"The profile ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-report-Profiles-{id}-delete", "x-filename-id":"api-report-profiles-id-delete" } }, "/api/report/Profiles":{ "get":{ "tags":[ "Report/Report Profiles" ], "summary":"Get Report Profiles", "description":"Gets a list of all report profiles and their attributes that match the specified parameters. If no parameters are specified, all report profiles and their attributes are returned.", "operationId":"report::Profiles::read", "parameters":[ { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/reportProfilesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-report-Profiles-get", "x-filename-id":"api-report-profiles-get" }, "post":{ "tags":[ "Report/Report Profiles" ], "summary":"Create a Report Profile", "description":"Creates a new report profile.
The minimum required properties in the request body are:\n ", "operationId":"report::Profiles::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/reportProfiles" } ], "required":[ "ReportProfileName", "NotificationProfileID", "Archive", "ArchiveExpiryDays", "Height", "Width", "AutoSize", "Zoom", "ReportFormat" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/reportProfilesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-report-Profiles-post", "x-filename-id":"api-report-profiles-post" } }, "/api/report/Profiles/readForSelect":{ "get":{ "tags":[ "Report/Report Profiles" ], "summary":"Get Report Profiles for Combo Boxes and Item Selectors", "description":"Get report profiles in a format suitable for combo boxes and item selectors.", "operationId":"report::Profiles::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" }, { "name":"query", "in":"query", "description":"Query search by report profile name.", "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/reportProfilesReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-report-Profiles-readForSelect-get", "x-filename-id":"api-report-profiles-readforselect-get" } }, "/api/rule/Rules":{ "post":{ "tags":[ "Rule/Rules" ], "summary":"Create a Rules File", "description":"Creates a new rules file.
The minimum required properties in the request body are:\n ", "operationId":"rule::Rules:create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ruleRules" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message.", "type":"string", "example":"Created rules file" } }, "type":"object" } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-rule-Rules-post", "x-filename-id":"api-rule-rules-post" } }, "/api/rule/Rules/{id}":{ "get":{ "tags":[ "Rule/Rules" ], "summary":"Get a Rule by ID", "description":"Gets the rule that matches the specified ID.", "operationId":"Rule::Rules:Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The path to the rules file to get, prefixed with id-. For example, to get the rules under a the discovery branch node, use id-core/default/collection/discovery. To get a the rules file for a specific leaf node, use id-core/default/collection/discovery/auto/base.includes.", "required":true, "schema":{ "type":"string" }, "example":"id-core" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/ruleRulesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-rule-Rules-{id}-get", "x-filename-id":"api-rule-rules-id-get" }, "put":{ "tags":[ "Rule/Rules" ], "summary":"Update a Rules File", "description":"Updates the properties of an existing rules file specified by the rule ID.", "operationId":"rule::Rules::update", "parameters":[ { "name":"id", "in":"path", "description":"The path to the rules file to update, prefixed with id-. For example, to update the auto discovery base includes rules, use id-core/default/collection/discovery/auto/base.includes.", "required":true, "schema":{ "type":"string" }, "example":"id-core" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ruleRules" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message.", "type":"string", "example":"Updated rules file" } }, "type":"object" } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-rule-Rules-{id}-put", "x-filename-id":"api-rule-rules-id-put" }, "delete":{ "tags":[ "Rule/Rules" ], "summary":"Delete a Rules File", "description":"Deletes a rules file specified by the rule ID.", "operationId":"rule::Rules::delete", "parameters":[ { "name":"id", "in":"path", "description":"The path to the rules file to delete, prefixed with id-. For example, to delete the auto discovery base includes rules, use id-core/default/collection/discovery/auto/base.includes.", "required":true, "schema":{ "type":"string" }, "example":"id-core" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message.", "type":"string", "example":"Deleted rules file" } } } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-rule-Rules-{id}-delete", "x-filename-id":"api-rule-rules-id-delete" } }, "/api/rule/Rules/read":{ "get":{ "tags":[ "Rule/Rules" ], "summary":"Get Rules", "description":"Gets a list of all rules and their attributes that match the specified parameters. If no parameters are specified, all rules and their attributes are returned.", "operationId":"rule::Rules:read", "parameters":[ { "name":"node", "in":"query", "description":"The path to the node to get rules for, prefixed with id-.", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/ruleRulesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-rule-Rules-read-get", "x-filename-id":"api-rule-rules-read-get" } }, "/api/rule/Rules/executeCheckSyntax":{ "post":{ "tags":[ "Rule/Rules" ], "summary":"Check Syntax for a Rule", "description":"Runs the rule file provided in the request body through the CheckSyntax utility and returns the result. The Content property is required in the request body.", "operationId":"rule::Rules::executeCheckSyntax", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ruleRulesExecuteCheckSyntax" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message.", "type":"string", "example":"Syntax Check OK" } }, "type":"object" } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-rule-Rules-executeCheckSyntax-post", "x-filename-id":"api-rule-rules-executechecksyntax-post" } }, "/api/rule/Rules/executeCreateFolder":{ "post":{ "tags":[ "Rule/Rules" ], "summary":"Create a Folder", "description":"Creates a new folder. The FolderName property is required in the request body. Anything specified for CommitLog is ignored and a default commit message is used.", "operationId":"rule::Rules::executeCreateFolder", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ruleRulesExecuteCreateFolder" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message.", "type":"string", "example":"SVN create folder successful" } }, "type":"object" } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-rule-Rules-executeCreateFolder-post", "x-filename-id":"api-rule-rules-executecreatefolder-post" } }, "/api/rule/Rules/createUploadFile":{ "post":{ "tags":[ "Rule/Rules" ], "summary":"Create a Rule From Upload", "description":"Creates a new rule from upload.
The minimum required properties in the request body are:\n ", "operationId":"rule::Rules::createUploadFile", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ruleRulesCreateUploadFile" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message.", "type":"string", "example":"Added file" } }, "type":"object" } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-rule-Rules-createUploadFile-post", "x-filename-id":"api-rule-rules-createuploadfile-post" } }, "/api/rule/Rules/executeRevert/{id}":{ "put":{ "tags":[ "Rule/Rules" ], "summary":"Revert a Rule to an Earlier Version", "description":"Reverts the specified rules file to an earlier version of the same file.
The minimum required properties in the request body are:\n ", "operationId":"rule::Rules::executeRevert", "parameters":[ { "name":"id", "in":"path", "description":"The path to the rules file to revert, prefixed with id-.", "required":true, "schema":{ "type":"string" }, "example":"id-core" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ruleRulesExecuteRevert" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message.", "type":"string", "example":"SVN revert successful" } }, "type":"object" } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-rule-Rules-executeRevert-{id}-put", "x-filename-id":"api-rule-rules-executerevert-id-put" } }, "/api/rule/Rules/executeDownload":{ "post":{ "tags":[ "Rule/Rules" ], "summary":"Download a Rules File", "description":"Downloads the file specified in the required file property in the request body.", "operationId":"rule::Rules::executeDownload", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ruleRulesExecuteDownload" } } } }, "responses":{ "200":{ "description":"Operation successful", "content":{ "application/octet-stream":{ "schema":{ "type":"string" } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-rule-Rules-executeDownload-post", "x-filename-id":"api-rule-rules-executedownload-post" } }, "/api/rule/Rules/readDiff":{ "get":{ "tags":[ "Rule/Rules" ], "summary":"Compare Rules Files and Revisions", "description":"Compares the specified rules files or file revisions and creates a diff to show the differences.", "operationId":"rule::Rules:readDiff", "parameters":[ { "name":"fromFile", "in":"query", "description":"The path to the file to compare on the \"from\" side of the diff.", "schema":{ "type":"string" }, "example":"example/base/auto/base.rules" }, { "name":"toFile", "in":"query", "description":"The path to the file to compare to on the \"to\" side of the diff.", "schema":{ "type":"string" }, "example":"example1/base/auto/base.rules" }, { "name":"fromRevision", "in":"query", "description":"The file revision number to compare on the \"from\" side of the diff.", "schema":{ "type":"string" }, "example":3 }, { "name":"toRevision", "in":"query", "description":"The file revision number to compare to on the \"to\" side of diff.", "schema":{ "type":"string" }, "example":3 } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message.", "type":"string", "example":"" }, "data":{ "description":"The diff comparing the rules files.", "type":"array", "items":{ "$ref":"#/components/schemas/ruleRulesReadDiff" } } }, "type":"object" } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-rule-Rules-readDiff-get", "x-filename-id":"api-rule-rules-readdiff-get" } }, "/api/rule/Rules/readRevisionHistory":{ "get":{ "tags":[ "Rule/Rules" ], "summary":"Get Revision History for a Rules File", "description":"Gets the revision history for the specified file.", "operationId":"rule::Rules:readRevisionHistory", "parameters":[ { "name":"node", "in":"query", "description":"The path to the node to get rules for, prefixed with id-.", "schema":{ "type":"string" }, "example":"id-core/example/auto/base.rules" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message.", "type":"string", "example":"Loaded file" }, "data":{ "description":"The revision history of the specified rules file.", "type":"array", "items":{ "$ref":"#/components/schemas/ruleRulesreadRevisionHistory" } } }, "type":"object" } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-rule-Rules-readRevisionHistory-get", "x-filename-id":"api-rule-rules-readrevisionhistory-get" } }, "/api/rule/Rules/createBranch":{ "post":{ "tags":[ "Rule/Rules" ], "summary":"Create a New Branch From an Existing Branch", "description":"Creates a new branch from an existing branch.
The minimum required properties in the request body are:\n ", "operationId":"rule::Rules:createBranch", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ruleRulesCreateBranch" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message.", "type":"string", "example":"Branch created" } }, "type":"object" } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-rule-Rules-createBranch-post", "x-filename-id":"api-rule-rules-createbranch-post" } }, "/api/rule/Branches/readForSelect":{ "get":{ "tags":[ "Rule/Rule Branches" ], "summary":"Show Branches for Combo Boxes and Item Selectors", "description":"Show branches in a format suitable for combo boxes and item selectors.", "operationId":"rule::Branches::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/ruleBranchesReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-rule-Branches-readForSelect-get", "x-filename-id":"api-rule-branches-readforselect-get" } }, "/api/rule/Branches/readRulesBranches":{ "get":{ "tags":[ "Rule/Rule Branches" ], "summary":"Get Rules Branches for Combo Boxes", "description":"Gets rules branches for combo boxes.", "operationId":"rule::Branches::readRulesBranches", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/ruleBranchesReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-rule-Branches-readRulesBranches-get", "x-filename-id":"api-rule-branches-readrulesbranches-get" } }, "/api/topology/Menus/{id}":{ "get":{ "tags":[ "Topology/Topology Menus" ], "summary":"Get a Topology Menu by ID.", "description":"Gets the topology menu that matches the specified ID.", "operationId":"topology::Menus:Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The menu ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/topologyMenusRead_byID" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-topology-Menus-{id}-get", "x-filename-id":"api-topology-menus-id-get" }, "put":{ "tags":[ "Topology/Topology Menus" ], "summary":"Update a Topology Menu", "description":"Updates the properties of an existing topology menu specified by the menu ID.\n", "operationId":"topology::Menus::update", "parameters":[ { "name":"id", "in":"path", "description":"The menu ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/topologyMenus" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"List of tool IDs in the menu.", "type":"array", "items":{ "$ref":"#/components/schemas/topologyMenus/properties/Tools" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-topology-Menus-{id}-put", "x-filename-id":"api-topology-menus-id-put" }, "delete":{ "tags":[ "Topology/Topology Menus" ], "summary":"Delete a Menu", "description":"Deletes the menu specified by the menu ID.", "operationId":"topology::Menus::delete", "parameters":[ { "name":"id", "in":"path", "description":"The menu ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-topology-Menus-{id}-delete", "x-filename-id":"api-topology-menus-id-delete" } }, "/api/topology/Menus":{ "get":{ "tags":[ "Topology/Topology Menus" ], "summary":"Get Topology Menus", "description":"Gets the list of all topology menus and their attributes that match the specified parameters. If no parameters are specified, all topology menus and their attributes are returned.", "operationId":"topology::Menus:read", "parameters":[ { "name":"node", "in":"query", "description":"The node to the tree.", "schema":{ "type":"string" } }, { "$ref":"#/components/parameters/sort" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/topologyMenusRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-topology-Menus-get", "x-filename-id":"api-topology-menus-get" }, "post":{ "tags":[ "Topology/Topology Menus" ], "summary":"Create a Menu", "description":"Creates a topology menu.
The minimum required properties in the request body are:\n \n", "operationId":"topology::Menus:create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/topologyMenus", "required":[ "TopologyMenuName", "ParentMenuID", "Tools" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "type":"object", "properties":{ "id":{ "description":"The menu ID.", "type":"integer", "example":"2" } } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-topology-Menus-post", "x-filename-id":"api-topology-menus-post" } }, "/api/topology/menus/readForSelect":{ "get":{ "tags":[ "Topology/Topology Menus" ], "summary":"Get Topology Menus for Combo Boxes and Item Selectors", "description":"Gets topology menus in a format suitable for combo boxes and item selectors.", "operationId":"topology::Menus::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/topologyMenusReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-topology-menus-readForSelect-get", "x-filename-id":"api-topology-menus-readforselect-get" } }, "/api/topology/Menus/readForMenu":{ "get":{ "tags":[ "Topology/Topology Menus" ], "summary":"Get Tools in a Menu", "description":"Get all the tools in the menu. The menu is either the restrictive menu or the default menu.", "operationId":"topology::Menus::readForMenu", "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/topologyMenusReadForMenu" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-topology-Menus-readForMenu-get", "x-filename-id":"api-topology-menus-readformenu-get" } }, "/api/topology/Menus/readForTree":{ "get":{ "tags":[ "Topology/Topology Menus" ], "summary":"Get Topology Menus for Tree Combos", "description":"Gets topology menus in a format suitable for tree combos. Specify the id query parameter to get the entire tree from root to the menu with the specified ID. Specify the node parameter if you want to get the children for the menu with the specified ID.", "operationId":"topology::Menus::readForTree", "parameters":[ { "name":"id", "in":"query", "description":"The menu ID to get the entire tree for, from the root to the menu with the specified ID.", "required":false, "schema":{ "type":"integer", "format":"int32" }, "example":"1" }, { "name":"node", "in":"query", "description":"The menu ID to get the children for.", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "oneOf":[ { "$ref":"#/components/schemas/topologyMenusReadForTreeNode" }, { "$ref":"#/components/schemas/topologyMenusReadForTreeID" } ] } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-topology-Menus-readForTree-get", "x-filename-id":"api-topology-menus-readfortree-get" } }, "/api/topology/Menus/readForTreeCombo":{ "get":{ "tags":[ "Topology/Topology Menus" ], "summary":"Get Topology Menus for Tree Combos", "description":"Gets topology menus in a format suitable for tree combos.", "operationId":"topology::Menus::readForTreeCombo", "parameters":[ { "name":"id", "in":"query", "description":"The menu ID.", "required":false, "schema":{ "type":"integer", "format":"int32" }, "example":"1" }, { "name":"node", "in":"query", "description":"The node to the tree.", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"3" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/topologyMenusReadForTreeNode" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-topology-Menus-readForTreeCombo-get", "x-filename-id":"api-topology-menus-readfortreecombo-get" } }, "/api/topology/Menus/updateMove":{ "put":{ "tags":[ "Topology/Topology Menus" ], "summary":"Move a Topology Menu to a Different Parent", "description":"Moves the topology menu specified in id to the parent specified in ParentMenuID.", "operationId":"topology::Menus::updateMove", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "id":{ "description":"The topology menu ID. The ID is given as \"id-MenuID\".", "type":"string", "example":"id-2", "required":true }, "ParentMenuID":{ "$ref":"#/components/schemas/topologyMenusRead_byID/properties/ParentMenuID", "required":true } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/topologyMenusRead_byID" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-topology-Menus-updateMove-put", "x-filename-id":"api-topology-menus-updatemove-put" } }, "/api/topology/Menus/updateTools":{ "put":{ "tags":[ "Topology/Topology Menus" ], "summary":"Move Topology Menu Tools", "description":"Move or copy the topology menu tools to a new menu. To move to a new menu, specify the SourceMenuID property. To copy, do not specify the SourceMenuID property.", "operationId":"topology::Menus::updateTools", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "id":{ "description":"The destination menu ID.", "type":"integer", "example":"1" }, "SourceMenuID":{ "description":"The source menu ID. Specify this property to move.", "type":"integer", "example":"2" }, "Tools":{ "$ref":"#/components/schemas/topologyMenus/properties/Tools" } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/topologyMenusRead_byID" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-topology-Menus-updateTools-put", "x-filename-id":"api-topology-menus-updatetools-put" } }, "/api/topology/NetworkDetails":{ "get":{ "tags":[ "Topology/Topology Network Details" ], "summary":"Get Network Details by Name", "description":"Gets a list of all network details and their attributes. You can use query parameters to customize the request.", "operationId":"topology::NetworkDetails:read", "parameters":[ { "name":"DeviceName", "in":"query", "description":"The serialized device name (device name and zone ID).", "schema":{ "type":"string" }, "example":"router.example.com;z1 OR router.example.com" }, { "name":"DetailName", "in":"query", "description":"The name of the network detail to get. Allowed values are DeviceInfo, Interfaces, IPRoutes, ARPTable, MACAddresses, VLANs, CDPNeighbors, and Neighbors.", "schema":{ "type":"string" }, "example":"Interfaces" }, { "name":"DeviceZoneName", "in":"query", "description":"The device zone name. Deprecated. Use serialized device name instead.", "schema":{ "type":"string" }, "example":"Default First Zone" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/topologyNetworkDetailsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-topology-NetworkDetails-get", "x-filename-id":"api-topology-networkdetails-get" } }, "/api/topology/NetworkDetails/readSummary":{ "get":{ "tags":[ "Topology/Topology Network Details" ], "summary":"Get Number of Records for Each Network Detail", "description":"Gets the number of records for each network detail.", "operationId":"topology::NetworkDetails:readSummary", "parameters":[ { "name":"DeviceID", "in":"query", "description":"The device ID.", "schema":{ "type":"integer" }, "example":9 } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/topologyNetworkDetailsReadSummary" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-topology-NetworkDetails-readSummary-get", "x-filename-id":"api-topology-networkdetails-readsummary-get" } }, "/api/topology/Tools/{id}":{ "get":{ "tags":[ "Topology/Topology Tools" ], "summary":"Get a Topology Tool by ID", "description":"Gets the topology tool that matches the specified ID.", "operationId":"topology::Tools:Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The tool ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/topologyToolsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-topology-Tools-{id}-get", "x-filename-id":"api-topology-tools-id-get" }, "put":{ "tags":[ "Topology/Topology Tools" ], "summary":"Update a Topology Tool", "description":"Updates the properties of an existing topology tool specified by the tool ID.\n", "operationId":"topology::Tools::update", "parameters":[ { "name":"id", "in":"path", "description":"The tool ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":"1" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/topologyTools" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/topologyToolsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-topology-Tools-{id}-put", "x-filename-id":"api-topology-tools-id-put" }, "delete":{ "tags":[ "Topology/Topology Tools" ], "summary":"Delete a Topology Tool", "description":"Deletes the topology tool specified by the tool ID.", "operationId":"topology::Tools::delete", "parameters":[ { "name":"id", "in":"path", "description":"The tool ID.", "required":true, "schema":{ "type":"integer", "format":"int32" }, "example":1 } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-topology-Tools-{id}-delete", "x-filename-id":"api-topology-tools-id-delete" } }, "/api/topology/Tools":{ "get":{ "tags":[ "Topology/Topology Tools" ], "summary":"Get Topology Tools", "description":"Gets the list of all topology tools and their attributes that match the specified parameters. If no parameters are specified, all topology tools and their attributes are returned.", "operationId":"topology::Tools:read", "parameters":[ { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/topologyToolsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-topology-Tools-get", "x-filename-id":"api-topology-tools-get" }, "post":{ "tags":[ "Topology/Topology Tools" ], "summary":"Create a Topology Tool", "description":"Creates a new topology tool.
The minimum required properties in the request body are:\n \nYou can use the following three properties to specify the context the tool is available in:\n \nIf you do not specify any, the tool is available in all topology graph contexts. If any of the properties are set, the tool applies only to the specified context.\n
The most inclusive selection applies. This means that if you set ContextElement to Edge, the tool is available for all edges, regardless of what you set in ContextEdgeType.", "operationId":"topology::Tools:create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/topologyTools", "required":[ "ToolName", "ToolTypeID", "ToolPath", "ToolPathTypeID", "ToolTarget", "Width", "Height" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/topologyToolsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-topology-Tools-post", "x-filename-id":"api-topology-tools-post" } }, "/api/topology/Tools/readForSelect":{ "get":{ "tags":[ "Topology/Topology Tools" ], "summary":"Get Topology Tools for Combo Boxes and Item Selectors", "description":"Gets topology tools in a format suitable for combo boxes and item selectors.", "operationId":"topology::Tools::readForSelect", "parameters":[ { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/topologyToolsReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-topology-Tools-readForSelect-get", "x-filename-id":"api-topology-tools-readforselect-get" } }, "/api/topology/Tools/executeViewTool":{ "get":{ "tags":[ "Topology/Topology Tools" ], "summary":"Run a Topology View Tool", "description":"Runs a topology view tool.", "operationId":"topology::Tools::executeViewTool", "parameters":[ { "name":"id", "in":"query", "description":"The ID of the tool to run.", "schema":{ "type":"integer", "format":"int32" }, "example":1 }, { "name":"NodeProps", "in":"query", "description":"The node properties.", "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/topologyToolsExecuteViewTools" } } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message.", "type":"string", "example":"" } }, "type":"object" } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-topology-Tools-executeViewTool-get", "x-filename-id":"api-topology-tools-executeviewtool-get" } }, "/api/link/Links/{id}":{ "get":{ "tags":[ "Link/Links" ], "summary":"Get a Link by ID", "description":"Gets the link that matches the specified ID.", "operationId":"link::Links::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The link ID.", "required":true, "schema":{ "type":"integer", "example":1001 } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/linkLinksRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-link-Links-{id}-get", "x-filename-id":"api-link-links-id-get" }, "put":{ "tags":[ "Link/Links" ], "summary":"Update a Link", "description":"Updates the properties of the link that matches the specified ID.", "operationId":"link::Links::update", "parameters":[ { "name":"id", "in":"path", "description":"The link ID.", "required":true, "schema":{ "type":"integer", "example":1001 } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/linkLinks" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the updated link.", "type":"array", "items":{ "$ref":"#/components/schemas/linkLinksRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-link-Links-{id}-put", "x-filename-id":"api-link-links-id-put" }, "delete":{ "tags":[ "Link/Links" ], "summary":"Delete a Link", "description":"Deletes the link that matches the specified ID.", "operationId":"link::Links::delete", "parameters":[ { "name":"id", "in":"path", "description":"The link ID.", "required":true, "schema":{ "type":"integer", "example":1001 } } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-link-Links-{id}-delete", "x-filename-id":"api-link-links-id-delete" } }, "/api/link/Links/":{ "get":{ "tags":[ "Link/Links" ], "summary":"Get Links", "description":"Gets the links that match the specified parameters. If no parameters are specified, all diagrams are returned.", "operationId":"link::Links::read", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of links that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/linkLinksRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-link-Links--get", "x-filename-id":"api-link-links-get" }, "post":{ "tags":[ "Link/Links" ], "summary":"Create a Link", "description":"Creates a link.
The minimum required properties in the request body are:\n ", "operationId":"link::Links::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/linkLinks", "required":[ "LinkName", "LinkPath", "LinkTypeID", "LinkIcon", "OwnerUserID", "OwnerUserGroupID" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new link.", "type":"array", "items":{ "$ref":"#/components/schemas/linkLinksRead" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-link-Links--post", "x-filename-id":"api-link-links-post" } }, "/api/link/Links/readForSelect":{ "get":{ "tags":[ "Link/Links" ], "summary":"Get Links for Combo Boxes and Item Selectors", "description":"Gets links in a format suitable for combo boxes and item selectors.", "operationId":"link::Links::readForSelect", "parameters":[ { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/query" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of links in a format suitable for combo boxes and item selectors.", "type":"array", "items":{ "$ref":"#/components/schemas/linkLinksReadForSelect" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-link-Links-readForSelect-get", "x-filename-id":"api-link-links-readforselect-get" } }, "/api/link/LinkGroups/{id}":{ "get":{ "tags":[ "Link/Link Groups" ], "summary":"Get a Link Group", "description":"Gets the link group that matches the specified ID.", "operationId":"link::LinkGroups::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The link group ID.", "required":true, "schema":{ "type":"integer", "example":1 } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "type":"array", "items":{ "$ref":"#/components/schemas/linkLinkGroupsReadByID" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-link-LinkGroups-{id}-get", "x-filename-id":"api-link-linkgroups-id-get" }, "put":{ "tags":[ "Link/Link Groups" ], "summary":"Update a Link Group", "description":"Updates the properties of the link Group that matches the specified ID.", "operationId":"link::LinkGroups::update", "parameters":[ { "name":"id", "in":"path", "description":"The link group ID.", "required":true, "schema":{ "type":"integer", "example":1 } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/linkLinkGroupsUpdate" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the updated link group.", "type":"array", "items":{ "$ref":"#/components/schemas/linkLinkGroupsReadByID" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-link-LinkGroups-{id}-put", "x-filename-id":"api-link-linkgroups-id-put" }, "delete":{ "tags":[ "Link/Link Groups" ], "summary":"Delete a Link Group", "description":"Deletes the link group that matches the specified ID.", "operationId":"link::LinkGroups::delete", "parameters":[ { "name":"id", "in":"path", "description":"The link group ID.", "required":true, "schema":{ "type":"integer", "example":1 } } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-link-LinkGroups-{id}-delete", "x-filename-id":"api-link-linkgroups-id-delete" } }, "/api/link/LinkGroups/":{ "get":{ "tags":[ "Link/Link Groups" ], "summary":"Get Link Groups for Tree Grids or Form Grids", "description":"Gets the link groups for the tree grid or the form grid.", "operationId":"link::LinkGroups::read", "parameters":[ { "name":"node", "description":"The node of the tree to get. You can specify root or the numerical ID.", "in":"query", "required":true, "schema":{ "type":"string", "example":"root" } }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/filter" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of link groups that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/linkLinkGroupsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-link-LinkGroups--get", "x-filename-id":"api-link-linkgroups-get" }, "post":{ "tags":[ "Link/Link Groups" ], "summary":"Create a Link Group", "description":"Creates a link group.
The minimum required properties in the request body are:\n ", "operationId":"link::LinkGroups::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/linkLinkGroups", "required":[ "LinkGroupName", "ParentLinkGroupID", "Links" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new link group.", "type":"object", "properties":{ "id":{ "description":"The ID of the new link group.", "type":"integer", "example":7 } } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-link-LinkGroups--post", "x-filename-id":"api-link-linkgroups-post" } }, "/api/link/LinkGroups/readForTree":{ "get":{ "tags":[ "Link/Link Groups" ], "summary":"Get Link Groups for Tree Grids", "description":"Gets link groups in a format suitable for tree grids.", "operationId":"link::LinkGroups::readForTree", "parameters":[ { "name":"node", "description":"The node of the tree to get. It can be root or LinkGroupID.", "in":"query", "required":true, "schema":{ "type":"string", "example":"root" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of link groups.", "type":"array", "items":{ "$ref":"#/components/schemas/linkLinkGroupsReadForTree" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-link-LinkGroups-readForTree-get", "x-filename-id":"api-link-linkgroups-readfortree-get" } }, "/api/link/LinkGroups/updateLinks":{ "put":{ "tags":[ "Link/Link Groups" ], "summary":"Move or Copy Links to a Different Group", "description":"Moves or copies links to a different group. To move, specify a source group in SourceLinkGroupID. To copy, do not specify a source group.", "operationId":"link::LinkGroups::updateLinks", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "id":{ "description":"The ID of the destination link group.", "type":"integer", "example":3 }, "SourceLinkGroupID":{ "description":"The ID of the source link group. To move links, specify an ID. To copy links, do not use this parameter.", "type":"integer", "example":"" }, "Links":{ "description":"The list of link IDs.", "type":"array", "items":{ "type":"integer", "example":[ 1, 2 ], "required":true } } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The destination link group with the moved or copied links.", "type":"array", "items":{ "$ref":"#/components/schemas/linkLinkGroupsReadByID" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-link-LinkGroups-updateLinks-put", "x-filename-id":"api-link-linkgroups-updatelinks-put" } }, "/api/link/LinkGroups/updateMove":{ "put":{ "tags":[ "Link/Link Groups" ], "summary":"Move Link Groups to a Different Parent", "description":"Move the link groups listed in id to the parent specified in ParentLinkGroupID.", "operationId":"link::LinkGroups::updateMove", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "id":{ "description":"The comma-separated list of link group IDs.", "type":"integer", "example":3 }, "ParentLinkGroupID":{ "description":"The ID of the parent to which the link group is moved.", "type":"integer", "example":1 } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the link group and the parent.", "type":"array", "items":{ "$ref":"#/components/schemas/linkLinkGroupsReadByID" } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-link-LinkGroups-updateMove-put", "x-filename-id":"api-link-linkgroups-updatemove-put" } }, "/api/link/LinkNavigation/readForTree":{ "get":{ "tags":[ "Link/Link Navigation" ], "summary":"Get Links and Link Groups Under a Specific Node", "description":"Gets links and link groups under a specific node.", "operationId":"link::LinkNavigation::readForTree", "parameters":[ { "name":"node", "description":"The node from the tree selection. It can be root or LinkGroupID.", "in":"query", "required":true, "schema":{ "type":"string", "example":"root" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of links and link groups.", "type":"array", "items":{ "$ref":"#/components/schemas/linkNavigationRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-link-LinkNavigation-readForTree-get", "x-filename-id":"api-link-linknavigation-readfortree-get" } }, "/api/SLM/Services/{id}":{ "get":{ "tags":[ "SLM/SLM Services" ], "summary":"Get an SLM Service by ID", "description":"Gets the SLM service that matches the specified ID.", "operationId":"SLM::Services::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The SLM service ID.", "required":true, "schema":{ "type":"string" }, "example":"2dc9dcc2-635b-4b63-9a0e-35dcb05458c0" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The properties of the specified SLM service.", "type":"array", "items":{ "$ref":"#/components/schemas/SLMServicesReadByID" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-SLM-Services-{id}-get", "x-filename-id":"api-slm-services-id-get" }, "put":{ "tags":[ "SLM/SLM Services" ], "summary":"Update an SLM Service", "description":"Updates the properties of the SLM service that matches the specified ID.
The minimum required properties in the request body are:\n ", "operationId":"SLM::Services::update", "parameters":[ { "name":"id", "in":"path", "description":"The SLM service ID.", "required":true, "schema":{ "type":"string" }, "example":"2dc9dcc2-635b-4b63-9a0e-35dcb05458c0" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SLMServices", "required":[ "ParentServiceID", "SLMType" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The properties of the updated SLM service.", "type":"array", "items":{ "$ref":"#/components/schemas/SLMServicesReadByID" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-SLM-Services-{id}-put", "x-filename-id":"api-slm-services-id-put" }, "delete":{ "tags":[ "SLM/SLM Services" ], "summary":"Delete an SLM Service", "description":"Deletes the SLM service that matches the specified ID.", "operationId":"SLM::Services::delete", "parameters":[ { "name":"id", "in":"path", "description":"The SLM service ID.", "required":true, "schema":{ "type":"string" }, "example":"2dc9dcc2-635b-4b63-9a0e-35dcb05458c0" } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-SLM-Services-{id}-delete", "x-filename-id":"api-slm-services-id-delete" } }, "/api/SLM/Services":{ "get":{ "tags":[ "SLM/SLM Services" ], "summary":"Get SLM Services", "description":"Gets the list of SLM services that match the specified parameters. If no parameters are specified, all SLM services are returned.", "operationId":"SLM::Services::read", "parameters":[ { "name":"node", "in":"query", "description":"The node of the tree to get.", "required":true, "schema":{ "type":"string" }, "example":"root" }, { "$ref":"#/components/parameters/sort" }, { "name":"RootID", "in":"query", "description":"The ID of the root node to start the service tree.", "required":false, "schema":{ "type":"integer" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of SLM services that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/SLMServicesRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-SLM-Services-get", "x-filename-id":"api-slm-services-get" }, "post":{ "tags":[ "SLM/SLM Services" ], "summary":"Create an SLM Service", "description":"Creates a new SLM service.
The minimum required properties in the request body are:\n ", "operationId":"SLM::Services::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SLMServices", "required":[ "ServiceName", "ParentServiceID", "Weight", "OwnerUserID", "OwnerUserGroupID", "StatusID" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The properties of the new SLM service.", "type":"array", "items":{ "$ref":"#/components/schemas/SLMServicesReadByID" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-SLM-Services-post", "x-filename-id":"api-slm-services-post" } }, "/api/SLM/Services/readPathFromServiceID":{ "get":{ "tags":[ "SLM/SLM Services" ], "summary":"Get Full Neo4j Path for a Service", "description":"Gets the full path in Neo4j for the service specified by ServiceID.", "operationId":"SLM::Services::readPathFromServiceID", "parameters":[ { "name":"ServiceID", "in":"query", "description":"The SLM service ID.", "required":true, "schema":{ "type":"string", "example":"2de8190b-4bd8-4a2a-91ec-03e9fdae83e0" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"The full path in Neo4j for the specified service.", "type":"array", "items":{ "type":"object", "properties":{ "Path":{ "description":"The path from the root node", "type":"string", "example":"//Root/" } } } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-SLM-Services-readPathFromServiceID-get", "x-filename-id":"api-slm-services-readpathfromserviceid-get" } }, "/api/SLM/Services/updateMove":{ "put":{ "tags":[ "SLM/SLM Services" ], "summary":"Move SLM Services to a Different Parent", "description":"Moves the specified SLM Services to a different parent.", "operationId":"SLM::Services::updateMove", "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "ParentServiceID":{ "description":"The new parent's service ID.", "type":"string", "example":"ba6b79e2-1778-4626-bc9d-369e0f1d7237" }, "ServiceName":{ "description":"The name of the service being moved, obtained automatically and used for validation.", "type":"string" }, "SLMType":{ "description":"The list of SLM types.", "type":"string", "example":"Filter" }, "id":{ "description":"The list of IDs.", "type":"string", "example":"id-ab08c765-7b93-4a34-aa36-821652e2cd6a" } } } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SuccessfulUpdateOperation" } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-SLM-Services-updateMove-put", "x-filename-id":"api-slm-services-updatemove-put" } }, "/api/SLM/ServiceFilters/{id}":{ "get":{ "tags":[ "SLM/Service Filters" ], "summary":"Get an SLM Filter", "description":"Gets the SLM filter that matches the specified ID.", "operationId":"SLM::ServiceFilters::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The SLM filter ID.", "required":true, "schema":{ "type":"string" }, "example":"2dc9dcc2-635b-4b63-9a0e-35dcb05458c0" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the specified SLM filter.", "type":"array", "items":{ "$ref":"#/components/schemas/SLMServiceFiltersRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-SLM-ServiceFilters-{id}-get", "x-filename-id":"api-slm-servicefilters-id-get" }, "put":{ "tags":[ "SLM/Service Filters" ], "summary":"Update an SLM Filter", "description":"Updates the properties of the SLM filter that matches the specified ID.", "operationId":"SLM::ServiceFilters::update", "parameters":[ { "name":"id", "in":"path", "description":"The SLM filter ID.", "required":true, "schema":{ "type":"string" }, "example":"2dc9dcc2-635b-4b63-9a0e-35dcb05458c0" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SLMServiceFilters" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the updated SLM filter.", "type":"array", "items":{ "$ref":"#/components/schemas/SLMServiceFiltersRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-SLM-ServiceFilters-{id}-put", "x-filename-id":"api-slm-servicefilters-id-put" }, "delete":{ "tags":[ "SLM/Service Filters" ], "summary":"Delete an SLM Filter", "description":"Deletes the SLM filter that matches the specified ID.", "operationId":"SLM::ServiceFilters::delete", "parameters":[ { "name":"id", "in":"path", "description":"The SLM filter ID.", "required":true, "schema":{ "type":"string" }, "example":"2dc9dcc2-635b-4b63-9a0e-35dcb05458c0" } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-SLM-ServiceFilters-{id}-delete", "x-filename-id":"api-slm-servicefilters-id-delete" } }, "/api/SLM/ServiceFilters":{ "post":{ "tags":[ "SLM/Service Filters" ], "summary":"Create an SLM Filter", "description":"Creates a new SLM Filter.
The minimum required properties in the request body are:\n ", "operationId":"SLM::ServiceFilters::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SLMServiceFilters", "required":[ "ServiceName", "ParentServiceID", "CompareField", "CompareMetric", "CompareOperator", "CompareValue", "Weight", "WhereClause", "OwnerUserID", "OwnerUserGroupID", "StatusID" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the new SLM filter.", "type":"array", "items":{ "$ref":"#/components/schemas/SLMServiceFiltersRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-SLM-ServiceFilters-post", "x-filename-id":"api-slm-servicefilters-post" } }, "/api/SLM/ServiceMetrics/{id}":{ "get":{ "tags":[ "SLM/Service Metrics" ], "summary":"Get an SLM Metric", "description":"Gets the SLM metric that matches the specified ID.", "operationId":"SLM::ServiceMetrics::Read_byID", "parameters":[ { "name":"id", "in":"path", "description":"The SLM metric ID.", "required":true, "schema":{ "type":"string" }, "example":"41d09c41-61f0-4827-801e-a54785ed4498" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"The properties of the specified SLM metric.", "type":"array", "items":{ "$ref":"#/components/schemas/SLMServiceMetricsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-SLM-ServiceMetrics-{id}-get", "x-filename-id":"api-slm-servicemetrics-id-get" }, "put":{ "tags":[ "SLM/Service Metrics" ], "summary":"Update an SLM Metric", "description":"Updates the properties of the SLM metric that matches the specified ID.", "operationId":"SLM::ServiceMetrics::update", "parameters":[ { "name":"id", "in":"path", "description":"The SLM metric ID.", "required":true, "schema":{ "type":"string" }, "example":"41d09c41-61f0-4827-801e-a54785ed4498" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SLMServiceMetrics" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulUpdateOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The properties of the updated SLM metric.", "type":"array", "items":{ "$ref":"#/components/schemas/SLMServiceMetricsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-SLM-ServiceMetrics-{id}-put", "x-filename-id":"api-slm-servicemetrics-id-put" }, "delete":{ "tags":[ "SLM/Service Metrics" ], "summary":"Delete an SLM Metric", "description":"Deletes the SLM metric that matches the specified ID.", "operationId":"SLM::ServiceMetrics::delete", "parameters":[ { "name":"id", "in":"path", "description":"The SLM metric ID.", "required":true, "schema":{ "type":"string" }, "example":"41d09c41-61f0-4827-801e-a54785ed4498" } ], "responses":{ "200":{ "$ref":"#/components/responses/SuccessfulDeleteResponse" }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-SLM-ServiceMetrics-{id}-delete", "x-filename-id":"api-slm-servicemetrics-id-delete" } }, "/api/SLM/ServiceMetrics":{ "post":{ "tags":[ "SLM/Service Metrics" ], "summary":"Create an SLM Metric", "description":"Creates a new SLM metric.
The minimum required properties in the request body are:\n ", "operationId":"SLM::ServiceMetrics::create", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SLMServiceMetrics", "required":[ "ParentServiceID", "ServiceName", "MetricID", "CompareType", "ThresholdID", "CompareOperator", "CompareValue", "WindowStatusID", "Weight", "OwnerUserID", "OwnerUserGroupID", "StatusID" ] } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulAddOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The properties of the new SLM metric.", "type":"array", "items":{ "$ref":"#/components/schemas/SLMServiceMetricsRead" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-SLM-ServiceMetrics-post", "x-filename-id":"api-slm-servicemetrics-post" } }, "/api/SLM/ServiceMetrics/readMetricInstances":{ "get":{ "tags":[ "SLM/Service Metrics" ], "summary":"Get Device Metrics of Specified Metric Type for Combo Boxes and Item Selectors", "description":"Gets device metric instances of the specified metric type in a format suitable for combo boxes and item selectors.", "operationId":"SLM::ServiceMetrics::readMetricInstances", "parameters":[ { "name":"DeviceID", "in":"query", "description":"The device ID of the device to get metrics from.", "required":true, "schema":{ "oneOf":[ { "type":"integer" }, { "type":"string" } ] }, "example":503 }, { "name":"MetricTypeID", "in":"query", "description":"The metric type ID.", "required":true, "schema":{ "type":"integer", "example":63 } }, { "name":"DeviceZoneID", "in":"query", "description":"The device zone ID.", "required":false, "schema":{ "type":"integer" }, "example":1 }, { "name":"DeviceZoneName", "in":"query", "description":"The device zone name.", "required":false, "schema":{ "type":"string" }, "example":"Default Zone" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/query" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of device metric instances of the specified metric type.", "type":"array", "items":{ "$ref":"#/components/schemas/SLMServiceMetricsReadMetricInstances" }, "example":[ { "MetricID":"583", "InstanceName":"Device", "DisplayInstanceName":"Device" }, { "MetricID":"583", "InstanceName":"Device", "DisplayInstanceName":"Device" } ] } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-SLM-ServiceMetrics-readMetricInstances-get", "x-filename-id":"api-slm-servicemetrics-readmetricinstances-get" } }, "/api/SLM/ServiceMetrics/readMetricTypes":{ "get":{ "tags":[ "SLM/Service Metrics" ], "summary":"Get Device Metric Types for Combo Boxes and Item Selectors", "description":"Gets device metric types in a format suitable for combo boxes and item selectors.", "operationId":"SLM::ServiceMetrics::readMetricTypes", "parameters":[ { "name":"id", "in":"query", "description":"The metric type ID.", "required":false, "schema":{ "type":"integer", "example":63 } }, { "name":"DeviceID", "in":"query", "description":"The device ID.", "required":true, "schema":{ "oneOf":[ { "type":"integer" }, { "type":"string" } ], "example":503 } }, { "name":"DeviceZoneID", "in":"query", "description":"The device zone ID.", "required":false, "schema":{ "type":"integer" }, "example":1 }, { "name":"DeviceZoneName", "in":"query", "description":"The device zone name.", "required":false, "schema":{ "type":"string" }, "example":"Default Zone" }, { "$ref":"#/components/parameters/filter" }, { "$ref":"#/components/parameters/limit" }, { "$ref":"#/components/parameters/query" }, { "$ref":"#/components/parameters/sort" }, { "$ref":"#/components/parameters/start" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of device metric types.", "type":"array", "items":{ "$ref":"#/components/schemas/SLMServiceMetricsReadMetricTypes" }, "example":[ { "MetricTypeID":"60", "MetricTypeName":"Latency", "Measurement":"metrictype_Latency" }, { "MetricTypeID":"61", "MetricTypeName":"Packet Loss", "Measurement":"metrictype_Packet_Loss" }, { "MetricTypeID":"62", "MetricTypeName":"Ping Jitter", "Measurement":"metrictype_Ping_Jitter" }, { "MetricTypeID":"63", "MetricTypeName":"Ping Jitter Utilization", "Measurement":"metrictype_Ping_Jitter_Utilization" } ] } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-SLM-ServiceMetrics-readMetricTypes-get", "x-filename-id":"api-slm-servicemetrics-readmetrictypes-get" } }, "/api/SLM/ServiceViews/readForTree":{ "get":{ "tags":[ "SLM/Service Views" ], "summary":"Get SLM Services for Tree Grids", "description":"Gets the SLM services that match the specified parameters in a format suitable for tree grids. If no parameters are specified, all SLM services are returned.", "operationId":"SLM::Services::readForTree", "parameters":[ { "name":"id", "in":"query", "description":"The SLM service path ID.", "required":false, "schema":{ "type":"string", "example":"//Root//Test" } }, { "name":"node", "in":"query", "description":"The node of the SLM service tree.", "required":false, "schema":{ "type":"string", "example":"root" } }, { "name":"RootID", "in":"query", "description":"The service ID specified for individual CRUD operations.", "required":false, "schema":{ "type":"string" } }, { "name":"TimeRange", "in":"query", "description":"The time range to get the data.", "required":false, "schema":{ "type":"string" } }, { "name":"readChildren", "in":"query", "description":"Whether to get the children of the specified service (true) or not (false).", "required":false, "schema":{ "type":"boolean" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"1" }, "data":{ "description":"The list of SLM services.", "type":"array", "items":{ "$ref":"#/components/schemas/SLMServiceViewsReadForTree" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-SLM-ServiceViews-readForTree-get", "x-filename-id":"api-slm-serviceviews-readfortree-get" } }, "/api/SLMNavigation/NavServices/readForTree":{ "get":{ "tags":[ "SLM/SLM Navigation" ], "summary":"Get SLM Service Details for Tree Grids", "description":"Gets the details for SLM services that match the specified parameters in a format suitable for tree grids. If no parameters are specified, all SLM services are returned.", "operationId":"SLMNavigation::NavServices::readForTree", "parameters":[ { "name":"node", "in":"query", "description":"The node for the tree selection. Specify root to get all SLM services from the root node or specify ServiceID to get all the child nodes under the service.", "required":false, "schema":{ "type":"string", "example":"root" } }, { "name":"query", "in":"query", "description":"The service name to get the details for. This simple query matches similar ServiceName values.", "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"The details of SLM services that match the specified parameters.", "type":"array", "items":{ "$ref":"#/components/schemas/SLMNavigationReadForTree" } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-SLMNavigation-NavServices-readForTree-get", "x-filename-id":"api-slmnavigation-navservices-readfortree-get" } }, "/api/SLMNavigation/NavServices/readStates":{ "get":{ "tags":[ "SLM/SLM Navigation" ], "summary":"Get the States of SLM Service Nodes Based On Child Nodes", "description":"Gets the summarized states for SLM service nodes based on the state of their child nodes.", "operationId":"SLMNavigation::NavServices::readStates", "parameters":[ { "name":"ServiceID", "in":"query", "description":"The comma-separated list of SLM service node IDs to get the state for.", "required":true, "schema":{ "type":"string", "example":"2de8190b-4bd8-4a2a-91ec-03e9fdae83e0" } }, { "name":"ServiceType", "in":"query", "description":"A PHP array parameter form. Specify the corresponding ServiceType for each SLM service node ID in the ServiceID list.", "required":true, "style":"form", "explode":true, "schema":{ "type":"array", "items":{ "type":"string" } } }, { "name":"MetricID", "in":"query", "description":"A PHP array parameter form. For each SLM service node in the ServiceId list that has the ServiceType of ServiceMetric, specify the MetricID in this form. For nodes of other types, leave the index entry in MetricID empty.", "required":true, "style":"form", "explode":true, "schema":{ "type":"array", "items":{ "type":"integer" } } }, { "name":"hasKeyFields", "in":"query", "description":"A reserved parameter. Its value is always 1.", "required":false, "schema":{ "type":"integer" } }, { "$ref":"#/components/parameters/start" }, { "$ref":"#/components/parameters/limit" } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"The list of summarized SLM service states.", "type":"array", "items":{ "type":"object", "properties":{ "ServiceID":{ "description":"The ID of the SLM service.", "type":"string", "example":"2de8190b-4bd8-4a2a-91ec-03e9fdae83e0" }, "Severity":{ "description":"The severity associated with the SLM service. Possible values are orange, red, green, and gray.", "type":"string", "example":"gray" } } } } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-SLMNavigation-NavServices-readStates-get", "x-filename-id":"api-slmnavigation-navservices-readstates-get" } }, "/api/SLMNavigation/NavServices/readForServiceFilter":{ "get":{ "tags":[ "SLM/SLM Navigation" ], "summary":"Get Constructed Event Filter for SLM Events", "description":"Gets the constructed event filter to filter SLM events for a specified node. The status of an SLM service node is derived from the SLM event severities generated from descending nodes (Service, Filter and Metric).", "operationId":"SLMNavigation::NavServices::readForServiceFilter", "parameters":[ { "name":"node", "in":"query", "description":"The ID of the service node for requesting severity status.", "required":true, "schema":{ "type":"string", "example":"root" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/SuccessfulGetOperation" }, { "type":"object", "properties":{ "data":{ "description":"The MySQL WHERE clause for filtering all the SLM events beneath the service node.", "type":"string", "example":"(Node='Test' OR EventKey='Service_Test') OR ( Node = 'Test' AND EventType = 'Event SLM' )" } } } ] } } } }, "default":{ "$ref":"#/components/responses/FailedOperation" } }, "x-internal-id":"api-SLMNavigation-NavServices-readForServiceFilter-get", "x-filename-id":"api-slmnavigation-navservices-readforservicefilter-get" } } }, "components":{ "schemas":{ "AAAAuthTypesCreate":{ "properties":{ "AuthenticationDomain":{ "description":"The domain to use for transient users. Also used for persistent Active Directory users.", "type":"string", "example":"ad.example.com" }, "ADHost1":{ "description":"The IP or FQDN of the primary server to use for Active Directory. Used for the Active Directory authentication type only.", "type":"string", "example":"ad1.example.com" }, "ADHost2":{ "description":"The IP or FQDN of the failover server to use for Active Directory. Used for the Active Directory authentication type only.", "type":"string", "example":"ad2.example.com" }, "ADSecureConnection":{ "description":"Whether to connect to Active Directory over a secure connection (1) or not (0). Used for the Active Directory authentication type only.", "type":"integer", "example":"1" }, "AuthenticationTypeName":{ "description":"The authentication type instance name. Use this to differentiate between multiple instances of the same protocol.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"SAML SSO 1" }, "AuthenticationTypeProtocol":{ "description":"The protocol used for the authentication type instance. Valid values are: The Internal authentication type instance exists by default, and you cannot create more of that type.", "type":"string", "example":"SAML" }, "AuthenticationStatus":{ "description":"Whether the authentication type instance is enabled (1) or not (0).", "type":"boolean", "example":"1" }, "Certificate":{ "description":"The SAML certificate. Used for the SAML authentication type only.", "type":"string" }, "DefaultInstance":{ "description":"Whether or not (1 or 0) to use this LDAP or Active Directory instance to authenticate when the username or domain specified at login does not match any of the other configured authentication protocols. There can only be one default instance. Used for the LDAP and Active Directory authentication types only.", "type":"boolean", "example":"1" }, "EntityID":{ "description":"The unique ID for your SAML-enabled identity provider. Used for the SAML authentication type only.", "type":"string", "example":"example.com/saml-idp" }, "GroupField":{ "description":"The field to look for user groups for transient users. The value can vary by authentication provider. For example, LDAP uses memberOf, and SAML might use member, eduPersonAffiliation, or any string. Used when authenticating transient users with external authentication types only.", "type":"string", "example":"memberOf" }, "LDAPDN":{ "description":"The LDAP distinguished name (dn) specific to your organization. Use %s as a variable for usernames. Used for the LDAP authentication type only.", "type":"string", "example":"CN=%s,OU=Users,DC=example,DC=com" }, "LDAPHost1":{ "description":"The IP or FQDN of the primary server to use for LDAP. Used for the LDAP authentication type only.", "type":"string", "example":"ldap.example.com" }, "LDAPHost2":{ "description":"The IP or FQDN of the secondary server to use for LDAP. Used for the LDAP authentication type only.", "type":"string", "example":"ldap2.example.com" }, "LDAPPort":{ "description":"Optional. The port to use for LDAP. Used for the LDAP authentication type only.", "type":"integer", "example":"636" }, "LDAPSecureConnection":{ "description":"The type of secure connection for LDAP. Valid values are: Used for the LDAP authentication type only.", "type":"integer", "example":"1" }, "NameIDFormat":{ "description":"The format of the name ID element of the SAML response. The Unified Assurance username for persistent users must match this format. Used for the SAML authentication type only.", "type":"string", "example":"urn:oasis:names:tc:SAML:2.0:nameid-format:persistent" }, "SingleLogoutService":{ "description":"The endpoint on your IdP that receives incoming logout requests and sends logout responses. Used for the SAML authentication type only.", "type":"string", "example":"example.com/saml/saml2/idp/SingleLogoutService.php" }, "SingleSignOnService":{ "description":"The endpoint on your IdP that receives authentication requests, processes them, and returns the authenticated user. Used for the SAML authentication type only.", "type":"string", "example":"example.com/saml/saml2/idp/SSOService.php" } }, "type":"object", "description":"The details of the authentication type instance to create." }, "AAAAuthTypesRead":{ "properties":{ "AuthenticationDomain":{ "description":"The domain to use for transient users. Also used for persistent Active Directory users.", "type":"string", "example":"ad.example.com" }, "ADHost1":{ "description":"The IP or FQDN of the primary server to use for Active Directory. Used for the Active Directory authentication type only.", "type":"string", "example":"ad1.example.com" }, "ADHost2":{ "description":"The IP or FQDN of the failover server to use for Active Directory. Used for the Active Directory authentication type only.", "type":"string", "example":"ad2.example.com" }, "ADSecureConnection":{ "description":"Whether to connect to Active Directory over a secure connection (1) or not (0). Used for the Active Directory authentication type only.", "type":"integer", "example":"1" }, "AuthenticationTypeID":{ "description":"The authentication type instance ID.", "type":"integer", "example":"1" }, "AuthenticationTypeName":{ "description":"The authentication type instance name. Use this to differentiate between multiple instances of the same protocol.", "type":"string", "example":"SAML SSO 1" }, "AuthenticationTypeProtocol":{ "description":"The protocol used for the authentication type instance. Valid values are: ", "type":"string", "example":"SAML" }, "AuthenticationStatusIcon":{ "description":"The authentication type instance status icon.", "type":"string", "example":"OrbGreen.png" }, "AuthenticationStatus":{ "description":"Whether the authentication type instance is enabled (1) or not (0).", "type":"boolean", "example":"1" }, "Certificate":{ "description":"The SAML certificate. Used for the SAML authentication type only.", "type":"string" }, "DefaultInstance":{ "description":"Whether or not (1 or 0) to use this LDAP or Active Directory instance to authenticate when the username or domain specified at login does not match any of the other configured authentication protocols. There can only be one default instance. Used for the LDAP and Active Directory authentication types only.", "type":"boolean", "example":"1" }, "EntityID":{ "description":"The unique ID for your SAML-enabled identity provider. Used for the SAML authentication type only.", "type":"string", "example":"example.com/saml-idp" }, "GroupField":{ "description":"The field to look for user groups for transient users. The value can vary by authentication provider. For example, LDAP uses memberOf, SAML might use member, eduPersonAffiliation, or any string. Used when authenticating transient users with external authentication types only.", "type":"string", "example":"memberOf" }, "LDAPDN":{ "description":"The LDAP distinguished name (dn) specific to your organization. Use %s as a variable for usernames. Used for the LDAP authentication type only.", "type":"string", "example":"CN=%s,OU=Users,DC=example,DC=com" }, "LDAPHost1":{ "description":"The IP or FQDN of the primary server to use for LDAP. Used for the LDAP authentication type only.", "type":"string", "example":"ldap.example.com" }, "LDAPHost2":{ "description":"The IP or FQDN of the secondary server to use for LDAP. Used for the LDAP authentication type only.", "type":"string", "example":"ldap2.example.com" }, "LDAPPort":{ "description":"Optional. The port to use for LDAP. Used for the LDAP authentication type only.", "type":"integer", "example":"636" }, "LDAPSecureConnection":{ "description":"The type of secure connection for LDAP. Valid values are: Used for the LDAP authentication type only.", "type":"integer", "example":"1" }, "NameIDFormat":{ "description":"The format of the name ID element of the SAML response. The Unified Assurance username for persistent users must match this format. Used for the SAML authentication type only.", "type":"string", "example":"urn:oasis:names:tc:SAML:2.0:nameid-format:persistent" }, "PasswordMinimumLength":{ "description":"The minimum password length. Used for the Internal authentication type only.", "type":"integer", "example":"4" }, "PasswordRequiredLowercase":{ "description":"The minimum number of lowercase letters required in the password. Used for the Internal authentication type only.", "type":"integer", "example":"1" }, "PasswordRequiredNumbers":{ "description":"The minimum number of numerals required in the password. Used for the Internal authentication type only.", "type":"integer", "example":"0" }, "PasswordRequiredSpecialCharacters":{ "description":"The minimum number of special characters required in the password. Used for the Internal authentication type only.", "type":"integer", "example":"0" }, "PasswordRequiredUppercase":{ "description":"The minimum number of uppercase letters required in the password. Used for the Internal authentication type only.", "type":"integer", "example":"0" }, "PasswordResetAvailable":{ "description":"The number of password resets available. Used for the Internal authentication type only.", "type":"integer", "example":"0" }, "PasswordResetCustomText":{ "description":"Custom text to show when resetting a password. This is used for internal authentication only.", "type":"string", "example":"Reset password" }, "PasswordResetQuestion1":{ "description":"The question to ask a user when they reset their password. This is used for internal authentication only.", "type":"string", "example":"What was the name of your first pet?" }, "SingleLogoutService":{ "description":"The endpoint on your IdP that receives incoming logout requests and sends logout responses. Used for the SAML authentication type only.", "type":"string", "example":"example.com/saml/saml2/idp/SingleLogoutService.php" }, "SingleSignOnService":{ "description":"The endpoint on your IdP that receives authentication requests, processes them, and returns the authenticated user. Used for the SAML authentication type only.", "type":"string", "example":"example.com/saml/saml2/idp/SSOService.php" } }, "type":"object", "description":"The authentication type instance details." }, "AAAAuthTypesUpdate":{ "properties":{ "AuthenticationDomain":{ "description":"The domain to use for transient users. Also used for persistent Active Directory users.", "type":"string", "example":"ad.example.com" }, "ADHost1":{ "description":"The IP or FQDN of the primary server to use for Active Directory. Used for the Active Directory authentication type only.", "type":"string", "example":"ad1.example.com" }, "ADHost2":{ "description":"The IP or FQDN of the failover server to use for Active Directory. Used for the Active Directory authentication type only.", "type":"string", "example":"ad2.example.com" }, "ADSecureConnection":{ "description":"Whether to connect to Active Directory over a secure connection (1) or not (0). Used for the Active Directory authentication type only.", "type":"integer", "example":"1" }, "AuthenticationTypeName":{ "description":"The authentication type instance name. Use this to differentiate between multiple instances of the same protocol.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"SAML SSO 1" }, "AuthenticationStatus":{ "description":"Whether the authentication type instance is enabled (1) or not (0).", "type":"boolean", "example":"1" }, "Certificate":{ "description":"The SAML certificate. Used for the SAML authentication type only.", "type":"string" }, "DefaultInstance":{ "description":"Whether or not (1 or 0) to use this LDAP or Active Directory instance to authenticate when the username or domain specified at login does not match any of the other configured authentication protocols. There can only be one default instance. Used for the LDAP and Active Directory authentication types only.", "type":"boolean", "example":"1" }, "EntityID":{ "description":"The unique ID for your SAML-enabled identity provider. Used for the SAML authentication type only.", "type":"string", "example":"example.com/saml-idp" }, "GroupField":{ "description":"The field to look for user groups for transient users. The value can vary by authentication provider. For example, LDAP uses memberOf, SAML might use member, eduPersonAffiliation, or any string. Used when authenticating transient users with external authentication types only.", "type":"string", "example":"memberOf" }, "LDAPDN":{ "description":"The LDAP distinguished name (dn) specific to your organization. Use %s as a variable for usernames. Used for the LDAP authentication type only.", "type":"string", "example":"CN=%s,OU=Users,DC=example,DC=com" }, "LDAPHost1":{ "description":"The IP or FQDN of the primary server to use for LDAP. Used for the LDAP authentication type only.", "type":"string", "example":"ldap.example.com" }, "LDAPHost2":{ "description":"The IP or FQDN of the secondary server to use for LDAP. Used for the LDAP authentication type only.", "type":"string", "example":"ldap2.example.com" }, "LDAPPort":{ "description":"Optional. The port to use for LDAP. Used for the LDAP authentication type only.", "type":"integer", "example":"636" }, "LDAPSecureConnection":{ "description":"The type of secure connection for LDAP. Valid values are: Used for the LDAP authentication type only.", "type":"integer", "example":"1" }, "NameIDFormat":{ "description":"The format of the name ID element of the SAML response. The Unified Assurance username for persistent users must match this format. Used for the SAML authentication type only.", "type":"string", "example":"urn:oasis:names:tc:SAML:2.0:nameid-format:persistent" }, "PasswordMinimumLength":{ "description":"The minimum password length. Used for the Internal authentication type only.", "type":"integer", "example":"4" }, "PasswordRequiredLowercase":{ "description":"The minimum number of lowercase letters required in the password. Used for the Internal authentication type only.", "type":"integer", "example":"1" }, "PasswordRequiredNumbers":{ "description":"The minimum number of numerals required in the password. Used for the Internal authentication type only.", "type":"integer", "example":"0" }, "PasswordRequiredSpecialCharacters":{ "description":"The minimum number of special characters required in the password. Used for the Internal authentication type only.", "type":"integer", "example":"0" }, "PasswordRequiredUppercase":{ "description":"The minimum number of uppercase letters required in the password. Used for the Internal authentication type only.", "type":"integer", "example":"0" }, "PasswordResetAvailable":{ "description":"The number of password resets available. Used for the Internal authentication type only.", "type":"integer", "example":"0" }, "PasswordResetCustomText":{ "description":"Custom text to show when resetting a password. This is used for internal authentication only.", "type":"string", "example":"Reset password" }, "PasswordResetQuestion1":{ "description":"The question to ask a user when they reset their password. This is used for internal authentication only.", "type":"string", "example":"What was the name of your first pet?" }, "SingleLogoutService":{ "description":"The endpoint on your IdP that receives incoming logout requests and sends logout responses. Used for the SAML authentication type only.", "type":"string", "example":"example.com/saml/saml2/idp/SingleLogoutService.php" }, "SingleSignOnService":{ "description":"The endpoint on your IdP that receives authentication requests, processes them, and returns the authenticated user. Used for the SAML authentication type only.", "type":"string", "example":"example.com/saml/saml2/idp/SSOService.php" } }, "type":"object", "description":"The details of the authentication type instance to update." }, "AAAAuthTypesReadForSelect":{ "properties":{ "AuthenticationTypeID":{ "description":"The authentication type instance ID.", "type":"integer", "example":"1" }, "AuthenticationTypeName":{ "description":"The authentication type instance name.", "type":"string", "example":"Internal" } }, "type":"object", "description":"Authentication type instance details." }, "AAAPermissionsRead":{ "properties":{ "PermissionID":{ "description":"The permission ID.", "type":"integer", "example":"10001" }, "PermissionName":{ "description":"The permission name.", "type":"string", "example":"SUPER" }, "PackageName":{ "description":"The package name.", "type":"string", "example":"global" }, "Multitenant":{ "description":"The multitenancy flag for the permission.", "type":"integer", "example":"0" }, "Description":{ "description":"The permission description.", "type":"string", "example":"Assigns administrative rights to view and modify items even if not the owner" } }, "type":"object", "description":"Permission details." }, "AAAPermissionsReadForSelect":{ "properties":{ "PermissionID":{ "description":"The permission ID.", "type":"integer", "example":"12001" }, "PermissionName":{ "description":"The permission name.", "type":"string", "example":"AuthTypes" }, "PackageName":{ "description":"The package name.", "type":"string", "example":"AAA" }, "ReadAvailable":{ "description":"Whether the Read operation is available for the permission (1) or not (0).", "type":"boolean", "example":"1" }, "CreateAvailable":{ "description":"Whether the Create operation is available for the permission (1) or not (0).", "type":"boolean", "example":"0" }, "UpdateAvailable":{ "description":"Whether the Update operation is available for the permission (1) or not (0).", "type":"boolean", "example":"1" }, "DeleteAvailable":{ "description":"Whether the Delete operation is available for the permission (1) or not (0).", "type":"boolean", "example":"0" }, "ExecuteAvailable":{ "description":"Whether the Execute operation is available for the permission (1) or not (0)", "type":"boolean", "example":"0" }, "Description":{ "description":"The description of the permission.", "type":"string", "example":"Manage authentication types for users" } }, "type":"object", "description":"Permission details. The <Operation>Available properties determine whether you can enable an operation for the permission." }, "AAAPreferenceRead":{ "properties":{ "PreferenceID":{ "description":"The preference ID.", "type":"integer", "example":"3" }, "PackageName":{ "description":"The package name.", "type":"string", "example":"event" }, "PreferenceName":{ "description":"The preference name.", "type":"string", "example":"DefaultDisplayID" }, "PreferenceDescription":{ "description":"The description of the preference.", "type":"string", "example":"Default event list display (default 'Default')" }, "RenderType":{ "description":"The render type.", "type":"string", "example":{ "id":"1", "name":"String" } }, "RenderTypeID":{ "description":"The render type ID.", "type":"integer", "example":"20004" } }, "type":"object", "description":"Preference details." }, "AAAPreferences":{ "properties":{ "PackageName":{ "description":"The package name.", "type":"string", "example":"event" }, "PreferenceName":{ "description":"The preference name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"DefaultDisplayID" }, "PreferenceDescription":{ "description":"The description of the preference.", "type":"string", "example":"Default event list display (default 'Default')" }, "RenderTypeID":{ "description":"The render type ID.", "type":"integer", "example":"20004" } }, "type":"object", "description":"Details of the preference to create or update." }, "AAAPreferencesReadForSelect":{ "properties":{ "PreferenceID":{ "description":"The preference ID.", "type":"integer", "example":"10" }, "PreferenceName":{ "description":"The preference name.", "type":"string", "example":"DefaultLink" }, "RenderType":{ "description":"The render type.", "type":"string", "example":{ "id":"1", "name":"String" } }, "Description":{ "description":"The description of the preference.", "type":"string", "example":"Link to use as the landing page after initial login" } }, "type":"object", "description":"Preference details." }, "AAARolesRead":{ "properties":{ "RoleID":{ "description":"The role ID.", "type":"integer", "example":"1" }, "RoleName":{ "description":"The role name.", "type":"string", "example":"Administrator" }, "Description":{ "description":"The description of the role.", "type":"string", "example":"Administrators have complete access to all user interfaces" }, "Permissions":{ "description":"The permissions associated with the role. The <Operation>Available properties determine whether it is possible to enable an operation for the permission and the <operation>Flag properties determine whether the operation is enabled.", "type":"array", "items":{ "type":"object", "properties":{ "PermissionID":{ "description":"The permission ID.", "type":"integer", "example":"10001" }, "PermissionName":{ "description":"The permission name.", "type":"string", "example":"SUPER" }, "PackageName":{ "description":"The package name.", "type":"string", "example":"global" }, "ReadAvailable":{ "description":"Whether the Read operation is available for the permission (1) or not (0).", "type":"integer", "example":"0" }, "CreateAvailable":{ "description":"Whether the Create operation is available for the permission (1) or not (0).", "type":"integer", "example":"0" }, "UpdateAvailable":{ "description":"Whether the Update operation is available for the permission (1) or not (0).", "type":"integer", "example":"0" }, "DeleteAvailable":{ "description":"Whether the Delete operation is available for the permission (1) or not (0).", "type":"integer", "example":"0" }, "ExecuteAvailable":{ "description":"Whether the Execute operation is available for the permission (1) or not (0).", "type":"integer", "example":"0" }, "Description":{ "description":"The description of the permission.", "type":"string", "example":"Assigns administrative rights to view and modify items even if not the owner" }, "ReadFlag":{ "description":"Whether the role has Read access for the permission (1) or not (0).", "type":"integer", "example":"0" }, "CreateFlag":{ "description":"Whether the role has Create access for the permission (1) or not (0).", "type":"integer", "example":"0" }, "UpdateFlag":{ "description":"Whether the role has Update access for the permission (1) or not (0).", "type":"integer", "example":"0" }, "DeleteFlag":{ "description":"Whether the role has Delete access for the permission (1) or not (0).", "type":"integer", "example":"0" }, "ExecuteFlag":{ "description":"Whether the role has Execute access for the permission (1) or not (0).", "type":"integer", "example":"0" } } } } }, "type":"object", "description":"Role details." }, "AAARoles":{ "properties":{ "RoleName":{ "description":"The role name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Administrator" }, "Description":{ "description":"The description of the role.", "type":"string", "example":"Administrators have complete access to all user interfaces" }, "Permissions":{ "description":"The permissions associated with the role. The <operation>Available properties determine whether it is possible to grant a permission and the <operation>Flag properties determine whether the permission is granted.", "type":"array", "items":{ "type":"object", "properties":{ "PermissionID":{ "description":"The permission ID.", "type":"integer", "example":"10001" }, "PermissionName":{ "description":"The permission name.", "type":"string", "example":"SUPER" }, "PackageName":{ "description":"The package name.", "type":"string", "example":"global" }, "ReadAvailable":{ "description":"Whether the Read operation is available for the permission (1) or not (0). Used for GET requests only. Do not set or change this when creating or updating a role.", "type":"integer", "example":"0" }, "CreateAvailable":{ "description":"Whether the Create operation is available for the permission (1) or not (0). Used for GET requests only. Do not set or change this when creating or updating a role.", "type":"integer", "example":"0" }, "UpdateAvailable":{ "description":"Whether the Update operation is available for the permission (1) or not (0). Used for GET requests only. Do not set or change this when creating or updating a role.", "type":"integer", "example":"0" }, "DeleteAvailable":{ "description":"Whether the Delete operation is available for the permission (1) or not (0). Used for GET requests only. Do not set or change this when creating or updating a role.", "type":"integer", "example":"0" }, "ExecuteAvailable":{ "description":"Whether the Execute operation is available for the permission (1) or not (0). Used for GET requests only. Do not set or change this when creating or updating a role.", "type":"integer", "example":"0" }, "Description":{ "description":"The description of the permission.", "type":"string", "example":"Assigns administrative rights to view and modify items even if not the owner" }, "ReadFlag":{ "description":"Whether the role has Read access for the permission (1) or not (0).", "type":"integer", "example":"0" }, "CreateFlag":{ "description":"Whether the role has Create access for the permission (1) or not (0).", "type":"integer", "example":"0" }, "UpdateFlag":{ "description":"Whether the role has Update access for the permission (1) or not (0).", "type":"integer", "example":"0" }, "DeleteFlag":{ "description":"Whether the role has Delete access for the permission (1) or not (0).", "type":"integer", "example":"0" }, "ExecuteFlag":{ "description":"Whether the role has Execute access for the permission (1) or not (0).", "type":"integer", "example":"0" } } } } }, "type":"object", "description":"Details of the role to create or update." }, "AAARolesReadForSelect":{ "properties":{ "RoleID":{ "description":"The role ID.", "type":"integer", "example":"1" }, "RoleName":{ "description":"The role name.", "type":"string", "example":"Administrator" } }, "type":"object", "description":"Role details." }, "AAATenantsRead":{ "properties":{ "TenantID":{ "description":"The tenant ID.", "type":"integer", "example":"1" }, "TenantName":{ "description":"The tenant name.", "type":"string", "example":"Oracle" }, "UserGroups":{ "description":"The list of user groups associated with the tenant.", "type":"array", "items":{ "type":"object", "properties":{ "UserGroupID":{ "description":"The user group ID.", "type":"integer", "example":"2" }, "UserGroupName":{ "description":"The user group name.", "type":"string", "example":"Operators" } } } }, "DeviceZones":{ "description":"The list of device zones associated with the tenant", "type":"array", "items":{ "type":"object", "properties":{ "DeviceZoneID":{ "description":"The device zone ID", "type":"integer", "example":"1" }, "DeviceZoneName":{ "description":"The device zone name.", "type":"string", "example":"Default First Zone" } } } } } }, "AAATenants":{ "properties":{ "TenantName":{ "description":"The tenant name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Oracle" }, "UserGroups":{ "description":"The list of user groups ID.", "type":"array", "items":{ "type":"integer" }, "example":[ 1, 3 ] }, "DeviceZones":{ "description":"The list of device zone IDs.", "type":"array", "items":{ "type":"integer" }, "example":[ 2, 3 ] } } }, "AAAUserGroupProperties":{ "properties":{ "PropertyName":{ "description":"The property name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"RestrictiveDeviceGroupID" }, "PropertyDescription":{ "description":"The description of the property.", "type":"string", "example":"Restricts device navigation and device-related data viewing to only devices within the specified Device Group and any sub groups" } }, "type":"object", "description":"Details of the user group property to create or update." }, "AAAUserGroupPropertiesRead":{ "properties":{ "PropertyID":{ "description":"The property ID.", "type":"integer", "example":"1" }, "PropertyName":{ "description":"The property name.", "type":"string", "example":"RestrictiveDeviceGroupID" }, "Description":{ "description":"The description of the property.", "type":"string", "example":"Restricts device navigation and device-related data viewing to only devices within the specified Device Group and any sub groups" } }, "type":"object", "description":"User group property details." }, "AAAUserGroupPropertiesReadForSelect":{ "properties":{ "PropertyID":{ "description":"The property ID.", "type":"integer", "example":"5" }, "PropertyName":{ "description":"The property name.", "type":"string", "example":"RestrictiveDashboardGroupID" }, "RenderType":{ "description":"The render type.", "type":"string", "example":{ "id":"1", "name":"String" } }, "Description":{ "description":"The description of the property.", "type":"string", "example":"Restricts portal navigation to only Adhoc portals and those within the specified Portal Group and any sub groups" } }, "type":"object", "description":"User group property details." }, "AAAUserGroupsRead":{ "properties":{ "UserGroupName":{ "description":"The user group name.", "type":"string", "example":"Administrators" }, "RoleID":{ "description":"The role ID.", "type":"integer", "example":"1" }, "RoleName":{ "description":"The role name.", "type":"string", "example":"Administrator" }, "UserGroupID":{ "description":"The user group ID.", "type":"integer", "example":"1" }, "Preferences":{ "description":"The user group preferences.", "type":"array", "items":{ "type":"object", "description":"A preference.", "properties":{ "PreferenceID":{ "description":"The preference ID.", "type":"integer", "example":"2" }, "PreferenceName":{ "description":"The preference name.", "type":"string", "example":"PageSize" }, "Description":{ "description":"The description of the preference.", "type":"string", "example":"Default pagination setting for grid views (default 1000)" }, "PreferenceValue":{ "description":"The preference value.", "type":"integer", "example":"1000" }, "Override":{ "description":"Whether the preference is unlocked (0) to allow users to override the group preference or locked (1) to prevent users from overriding it.", "type":"integer", "example":"0" } } } }, "Properties":{ "description":"The user group properties.", "type":"array", "items":{ "type":"object", "properties":{ "PropertyID":{ "description":"The property ID.", "type":"integer", "example":"1" }, "PropertyName":{ "description":"The property name.", "type":"string", "example":"RestrictiveDeviceGroupID" }, "PropertyValue":{ "description":"The property value.", "type":"integer", "example":"1" }, "Description":{ "description":"The description of the property.", "type":"string", "example":"Restricts device navigation and device-related data viewing to only devices within the specified Device Group and any sub groups" } } } }, "Users":{ "description":"The users in the group.", "type":"array", "items":{ "type":"object", "properties":{ "UserID":{ "description":"The user ID.", "type":"integer", "example":"1065" }, "UserName":{ "description":"The user name.", "type":"string", "example":"Operator" } } } } }, "type":"object", "description":"User group details." }, "AAAUserGroups":{ "properties":{ "UserGroupName":{ "description":"The user group name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Administrators" }, "RoleID":{ "description":"The role ID.", "type":"integer", "example":"1" }, "Properties":{ "description":"The user group properties.", "type":"array", "items":{ "type":"object", "properties":{ "PropertyID":{ "description":"The property ID.", "type":"integer", "example":"1" }, "PropertyName":{ "description":"The property name.", "type":"string", "example":"RestrictiveDeviceGroupID" }, "PropertyValue":{ "description":"The property value.", "type":"integer", "example":"1" }, "Description":{ "description":"The property description.", "type":"string", "example":"Restricts device navigation and device-related data viewing to only devices within the specified Device Group and any sub groups" } } } }, "Preferences":{ "description":"The user group preferences.", "type":"array", "items":{ "type":"object", "properties":{ "PreferenceID":{ "description":"The preference ID.", "type":"integer", "example":"2" }, "PreferenceName":{ "description":"The preference name.", "type":"string", "example":"PageSize" }, "PreferenceValue":{ "description":"The preference value.", "type":"integer", "example":"1000" }, "Description":{ "description":"The description of the preference.", "type":"string", "example":"Default pagination setting for grid views (default 1000)" }, "Required":{ "description":"Whether the field is required (true) or not (false).", "type":"boolean", "example":"false" }, "Override":{ "description":"Whether the preference is unlocked (0) to allow users to override the group preference or locked (1) to prevent users from overriding it.", "type":"integer", "example":"1" } } } }, "Users":{ "description":"The IDs of the users in the group.", "type":"array", "items":{ "type":"integer" }, "example":[ 1065 ] } }, "type":"object", "description":"Details of the user group to create or update." }, "AAAUserGroupsReadForSelect":{ "properties":{ "UserGroupID":{ "description":"The user group ID.", "type":"integer", "example":"1" }, "UserGroupName":{ "description":"The user group name.", "type":"string", "example":"Administrators" } }, "type":"object", "description":"User group details." }, "AAAUserProfiles":{ "properties":{ "AuthenticationType":{ "description":"The authentication type ID. Use 1 for internal. Otherwise, make a GET request at the /api/AAA/AuthTypes endpoint to find IDs.
", "type":"integer", "example":1 }, "AccountStatus":{ "description":"A flag to indicate whether the user account is enabled (1) or disabled (0).", "type":"integer", "example":1 }, "EmailAddress":{ "description":"The user email address.", "type":"string", "example":"example@example.com" }, "Password":{ "description":"The user's password. Required for Internal authentication only.", "type":"string", "example":"" }, "RepeatPassword":{ "description":"The user's password, repeated. Required for Internal authentication only.", "type":"string", "example":"" }, "Properties":{ "description":"The user's properties.", "type":"array", "items":{ "type":"object", "properties":{ "PropertyID":{ "description":"The property ID.", "type":"integer", "example":"1" }, "PropertyName":{ "description":"The property name.", "type":"string", "example":"ResetQuestion" }, "PropertyValue":{ "description":"The property value.", "type":"string", "example":"resetval" }, "Description":{ "description":"The description of the property.", "type":"string", "example":"A new property." }, "id":{ "type":"integer", "example":2 } } } }, "Preferences":{ "description":"The user preferences.", "type":"array", "items":{ "type":"object", "properties":{ "PreferenceID":{ "description":"The preference ID.", "type":"integer", "example":"3" }, "PreferenceName":{ "description":"The preference name.", "type":"string", "example":"DefaultDisplayID" }, "PreferenceValue":{ "description":"The preference value.", "type":"integer", "example":"5" }, "Description":{ "description":"The description of the preference.", "type":"string", "example":"Default event list display (default 'Default')" }, "Override":{ "description":"Whether the preference is unlocked (0), allowing the user to override their group preference, or locked (1), preventing the user from overriding it.", "type":"integer", "example":"0" } } } } }, "type":"object", "description":"Details of the user profile to update." }, "AAAUserProperties":{ "properties":{ "PropertyName":{ "description":"The property name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"ResetQuestion" }, "Description":{ "description":"The description of the property.", "type":"string", "example":"Reserved for future use" } }, "type":"object", "description":"Details of the user property to create or update." }, "AAAUserPropertiesRead":{ "properties":{ "PropertyID":{ "description":"The property ID.", "type":"integer", "example":"1" }, "PropertyName":{ "description":"The property name.", "type":"string", "example":"ResetQuestion" }, "Description":{ "description":"The description of the property.", "type":"string", "example":"Reserved for future use" } }, "type":"object", "description":"Details of the user property." }, "AAAUserPropertiesReadForSelect":{ "properties":{ "PropertyID":{ "description":"The property ID.", "type":"integer", "example":"1" }, "PropertyName":{ "description":"The property name.", "type":"string", "example":"ResetQuestion" }, "RenderType":{ "description":"The render type.", "type":"string", "example":{ "id":"1", "name":"String" } }, "Description":{ "description":"The description property.", "type":"string", "example":"Reserved for future use" } }, "type":"object", "description":"Details of the user property." }, "AAAUsersRead":{ "properties":{ "UserID":{ "description":"The user ID.", "type":"integer", "example":"1065" }, "UserName":{ "description":"The user name.", "type":"string", "example":"operator" }, "FullName":{ "description":"The full name of the user.", "type":"string", "example":"Operator" }, "EmailAddress":{ "description":"The user email address.", "type":"string", "example":"example@example.com" }, "LastLoginSuccess":{ "description":"The last successful login attempt.", "type":"integer", "example":"0" }, "LastLoginFailed":{ "description":"The last failed login attempt.", "type":"integer", "example":"0" }, "PasswordExpiration":{ "description":"The value of the PasswordExpiration field can vary depending on the PasswordChange setting and the expiration details provided when setting up the user
If PasswordChange is set to 'immediate', this field returns 0 to indicate that Force Password Change is set to \"At Next Login\".
If PasswordChange is set to 'never', this field returns a future date such as \"2038-01-19 01:14:07\".
If PasswordChange is set to 'date', this field returns whatever future date was specified.", "type":"string", "example":"2025-10-04 12:30:00 or 2025-10-04" }, "AccountExpiration":{ "description":"The date and time when the account's password will expire. 0 means it never expires.", "type":"string", "example":"2025-10-04 12:30:00 or 2025-10-04" }, "FailedLoginCount":{ "description":"The number of failed logins.", "type":"integer", "example":"0" }, "AuthenticationType":{ "description":"The authentication type instance for the user..", "type":"object", "properties":{ "id":{ "description":"The unique identifier for the authentication type instance.", "type":"integer" }, "name":{ "description":"The name for the authentication type instance.", "type":"string" } }, "example":{ "id":"1", "name":"Internal" } }, "AccountStatus":{ "description":"A flag to indicate if the user account is enabled (1) or disabled (0).", "type":"integer", "example":"1" }, "SupportUsername":{ "description":"The support user name.", "type":"string", "example":"" }, "UserGroupName":{ "description":"The user group name.", "type":"string", "example":"Administrators" }, "AuthenticationTypeName":{ "description":"The authentication type instance name.", "type":"string", "example":"Internal" }, "UserGroup":{ "description":"The user group.", "type":"object", "properties":{ "id":{ "description":"The unique identifier for the primary user group from which the user inherits configurations which includes roles, properties, and preferences.", "type":"integer" }, "name":{ "description":"The user group name.", "type":"string" } }, "example":{ "id":"1", "name":"Administrators" } }, "Subgroups":{ "description":"A list of the user's subgroup IDs. Users inherit only restrictive access properties set for the subgroup, not roles or preferences.", "type":"array", "example":"[2, 1001]" }, "Password":{ "description":"The user's password. Required for Internal authentication only.", "type":"string", "example":"" }, "RepeatPassword":{ "description":"The user's password, repeated. Required for Internal authentication only.", "type":"string", "example":"" }, "Properties":{ "description":"The user's properties.", "type":"array", "items":{ "type":"object", "properties":{ "PropertyID":{ "description":"The property ID.", "type":"integer", "example":"1" }, "PropertyName":{ "description":"The property name.", "type":"string", "example":"ResetQuestion" }, "PropertyValue":{ "description":"The property value.", "type":"string", "example":"resetval" }, "Description":{ "description":"The description associated with the property.", "type":"string", "example":"Reserved for future use" } } } }, "Preferences":{ "description":"The user preferences.", "type":"array", "items":{ "type":"object", "properties":{ "PreferenceID":{ "description":"The preference ID.", "type":"integer", "example":"3" }, "PreferenceName":{ "description":"The preference name.", "type":"string", "example":"DefaultDisplayID" }, "PreferenceValue":{ "description":"The preference value.", "type":"string", "example":"5" }, "Description":{ "description":"The preference description.", "type":"string", "example":"Default event list display (default 'Default')" }, "Override":{ "description":"Whether the preference is unlocked (0), allowing the user to override their group preference, or locked (1), preventing the user from overriding it.", "type":"integer", "example":0 } } } } }, "description":"User details." }, "AAAUsers":{ "properties":{ "UserName":{ "description":"The username.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"operator" }, "FullName":{ "description":"The full name of the user.", "type":"string", "example":"Operator" }, "EmailAddress":{ "description":"The user email address.", "type":"string", "example":"example@example.com" }, "AuthenticationType":{ "description":"Unique identifier for the authentication type instance.", "type":"integer", "example":1 }, "Password":{ "description":"The user's password. Required for Internal authentication only.", "type":"string", "example":"" }, "RepeatPassword":{ "description":"The user's password, repeated. Required for Internal authentication only.", "type":"string", "example":"" }, "PasswordChange":{ "description":"When the user's password will expire.\nAllowed values are: \n", "type":"string", "example":"date" }, "PasswordExpiration":{ "description":"The password expiration date, in YYYY-MM-DD HH:MM:SS format.\n
When the PasswordChange property is set to date, set PasswordExpiration to a valid future date. If you use a past date, the user must change their password the next time they log in.\n
When the PasswordChange property is set to never or immediate, do not set PasswordExpiration. In this case, the API automatically sets the valid values, and PasswordExpiration will be ignored if you set it.", "type":"string", "example":"2025-10-04 12:30:00 or 2025-10-04" }, "UserGroup":{ "description":"The unique identifier for the primary user group from which the user inherits configurations, including roles, properties, and preferences.", "type":"integer", "example":1 }, "Subgroups":{ "description":"A list of the user's subgroup IDs. Users inherit only restrictive access properties set for the subgroup, not roles or preferences. The same group cannot appear in both the UserGroup (primary) and Subgroups list for the user.", "type":"array", "example":"[2, 1001]" }, "AccountExpiration":{ "description":"The date and time when the account's password will expire. Set to 0 for never, or a date/time string in a format parsable by the strtotimeM PHP function.", "type":"string", "example":"2025-10-04 12:30:00 or 2025-10-04" }, "AccountStatus":{ "description":"A flag to indicate if the user account is enabled or disabled. Possible values are 0 for disabled or 1 for enabled.", "type":"string", "example":"1" }, "SupportUsername":{ "description":"The support user name.", "type":"string", "example":"" }, "SupportPassword":{ "description":"The Unified Assurance support site password.", "type":"string", "example":"" }, "Properties":{ "description":"The user's properties.", "type":"array", "items":{ "type":"object", "properties":{ "PropertyID":{ "description":"The property ID.", "type":"integer", "example":"1" }, "PropertyName":{ "description":"The property name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"ResetQuestion" }, "PropertyValue":{ "description":"The property value.", "type":"string", "example":"resetval" }, "Description":{ "description":"The description of the property.", "type":"string", "example":"Reserved for future use" }, "id":{ "type":"integer", "example":2 } } } }, "Preferences":{ "description":"The user preferences.", "type":"array", "items":{ "type":"object", "properties":{ "PreferenceID":{ "description":"The preference ID.", "type":"integer", "example":"3" }, "PreferenceName":{ "description":"The preference name.", "type":"string", "example":"DefaultDisplayID" }, "PreferenceValue":{ "description":"The preference value.", "type":"integer", "example":5 }, "Description":{ "description":"The preference description.", "type":"string", "example":"Default event list display (default 'Default')" }, "Override":{ "description":"Whether the preference is unlocked (0), allowing the user to override their group preference, or locked (1), preventing the user from overriding it.", "type":"integer", "example":0 }, "id":{ "type":"integer", "example":1 } } } } }, "description":"Details of the user to create or update." }, "AAAUsersReadForSelect":{ "properties":{ "UserID":{ "description":"The user ID.", "type":"string", "example":"1057" }, "UserName":{ "description":"The user name.", "type":"string", "example":"Operator" } }, "type":"object", "description":"User details." }, "brokerJobsRead":{ "properties":{ "BrokerJobID":{ "description":"The job ID.", "type":"integer", "example":"1" }, "ServerID":{ "description":"The server ID specified for job association.", "type":"integer", "example":"1" }, "ServerName":{ "description":"The server name.", "type":"string", "example":"example.com" }, "PackageName":{ "description":"The package name.", "type":"string", "example":"presentation-app" }, "JobName":{ "description":"The job reference name.", "type":"string", "example":"Data backup" }, "JobDescription":{ "description":"The optional human-readable job description.", "type":"string", "example":"This is an example description" }, "JobProgram":{ "description":"The job program file location and name (path of executable relative to $BASEDIR).", "type":"string", "example":"/opt/assure1" }, "JobArguments":{ "description":"The optional job program arguments.", "type":"string", "example":"--ssl-ca=/ssl/BundleCA.crt" }, "IsScheduled":{ "description":"Whether the job is scheduled (1) or not (0).", "type":"integer", "example":"0" }, "Minutes":{ "description":"The minutes when the job is scheduled to run, in cron format. Can be a comma-separated list of integers, or * to indicate every minute.", "type":"string", "example":"0" }, "Hours":{ "description":"The hours when the job is scheduled to run, in cron format. Can be a comma-separated list of integers, or * to indicate every hour.", "type":"string", "example":"1" }, "Days":{ "description":"The days when the job is scheduled to run, in cron format. Can be a comma-separated list of integers, or * to indicate every day.", "type":"string", "example":"1" }, "Months":{ "description":"The months when the job is scheduled to run, in cron format. Can be a comma-separated list of integers, or * to indicate every month.", "type":"string", "example":"2" }, "WeekDays":{ "description":"The weekdays when the job is scheduled to run, in cron format. Can be a comma-separated list of integers, or * to indicate every weekday.", "type":"string", "example":"6" }, "FailoverType":{ "description":"The failover Type ID.\nAllowed Values:\n", "type":"integer", "example":"0" }, "FailoverTypeName":{ "description":"The failover type name.", "type":"string", "example":"Standalone" }, "PrimaryJobID":{ "description":"The primary job ID specified for failover.", "type":"integer", "example":"0" }, "StatusID":{ "description":"The job status ID. Either 0 (disabled) or 1 (enabled).", "type":"integer", "example":"0" }, "Status":{ "description":"The status, based on the value of the StatusID property. When StatusID is 0, Status is Disabled. When StatusID is 1, Status is Enabled.", "type":"string", "example":"Disabled" }, "StatusIcon":{ "description":"The status image name based on the the statusID. If the statusID is 0, then the StatusIcon is OrbRed.png. If the statusID is 1, then the StatusIcon is OrbGreen.png.", "type":"string", "example":"OrbRed.png" }, "Privileged":{ "description":"Whether the process should be run as a privileged user (1) or not (o).", "type":"integer", "example":"0" }, "PrimaryServerID":{ "description":"The database ID that identifies the primary server of the given server type (presentation, collection, database) in Assure1.Servers table.", "type":"integer", "example":"1" }, "PrimaryJobServerID":{ "description":"The server ID of the server primarily responsible for the job.", "type":"integer", "example":"1", "nullable":true }, "Decouple":{ "description":"Allows for different combinations of primary/backup job pairings or pairing jobs across servers that are not tied together.", "type":"boolean", "example":"1" }, "ApplicationConfig":{ "$ref":"#/components/schemas/ApplicationConfig" }, "State":{ "description":"The indicator of the job state.", "type":"string", "example":"Running" }, "StateIcon":{ "description":"The icon for representing the job states.", "type":"string", "example":"OrbGreenUp.png" } }, "type":"object" }, "brokerJobsCreate":{ "properties":{ "ServerID":{ "description":"The server ID specified for job association.", "type":"integer", "example":"1" }, "PackageName":{ "description":"The package name.", "type":"string", "example":"presentation-app" }, "JobName":{ "description":"The job reference name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Data backup" }, "JobDescription":{ "description":"The optional human-readable job description.", "type":"string", "example":"This is an example description" }, "JobProgram":{ "description":"The job program file location & name (Path of executable relative to $BASEDIR).", "type":"string", "example":"/opt/assure1" }, "JobArguments":{ "description":"The optional job program arguments.", "type":"string", "example":"--ssl-ca=/ssl/BundleCA.crt" }, "IsScheduled":{ "description":"Whether the job is scheduled (1) or not (0).", "type":"integer", "example":"0" }, "Minutes":{ "description":"The minutes when the job is scheduled to run, in cron format. Use a comma-separated list of integers, or * to indicate every minute.", "type":"string", "example":"0" }, "Hours":{ "description":"The hours when the job is scheduled to run, in cron format. Use a comma-separated list of integers, or * to indicate every hour.", "type":"string", "example":"1" }, "Days":{ "description":"The days when the job is scheduled to run, in cron format. Use a comma-separated list of integers, or * to indicate every day.", "type":"string", "example":"1" }, "Months":{ "description":"The months when the job is scheduled to run, in cron format. Use a comma-separated list of integers, or * to indicate every month.", "type":"string", "example":"2" }, "WeekDays":{ "description":"The weekdays when the job is scheduled to run, in cron format. Use a comma-separated list of integers, or * to indicate every weekday.", "type":"string", "example":"6" }, "FailoverType":{ "description":"The failover type ID.\nAllowed Values:\n", "type":"integer", "example":"0" }, "PrimaryJobID":{ "description":"The primary job ID specified for failover.", "type":"integer", "example":"0" }, "StatusID":{ "description":"The job status ID. Either 0 (disabled) or 1 (enabled).", "type":"integer", "example":"0" }, "Privileged":{ "description":"Whether the process should be run as a privileged user (1) or not (0).", "type":"integer", "example":"0" }, "ApplicationConfig":{ "$ref":"#/components/schemas/ApplicationConfig" } }, "type":"object" }, "brokerJobsReadForSelect":{ "properties":{ "BrokerJobID":{ "description":"The job ID.", "type":"integer", "example":"1" }, "JobName":{ "description":"The job reference name.", "type":"string", "example":"Backup" } }, "type":"object" }, "ApplicationConfig":{ "description":"The array of JSON objects containing all the configuration values for the job.", "type":"array", "items":{ "type":"object", "properties":{ "Required":{ "description":"Whether the configuration value can be left blank or not.", "type":"boolean", "example":0 }, "BrokerApplicationConfigName":{ "description":"The application configuration name.", "type":"string", "example":"LogLevel" }, "BrokerApplicationConfigValue":{ "description":"The application configuration value.", "type":"string", "example":"Error" }, "BrokerApplicationConfigTypeID":{ "description":"The application configuration type ID.", "type":"integer", "example":1 } } } }, "brokerJobsReadStates":{ "type":"object", "properties":{ "BrokerJobID":{ "description":"The job ID.", "type":"integer", "example":"1" }, "State":{ "description":"The indicator of the job state.", "type":"string", "example":"Running" }, "StateIcon":{ "description":"The icon for representing the job state.", "type":"string", "example":"OrbGreenUp.png" } } }, "brokerServersReadStates":{ "type":"object", "properties":{ "ServerID":{ "description":"The broker server ID.", "type":"integer", "example":"1" }, "State":{ "description":"The indicator of the server state. \nPossible Values: \n", "type":"string", "example":"Running" }, "StateIcon":{ "description":"The icon for representing the server state.", "type":"string", "example":"OrbGreenUp.png" } } }, "brokerFailoverStatesRead":{ "type":"object", "properties":{ "id":{ "description":"A general unique ID for the object.", "type":"string", "example":"652b5238333f6" }, "Grouping":{ "description":"The logical grouping.", "type":"string", "example":"StandardThreshold" }, "PackageName":{ "description":"The package name.", "type":"string", "example":"coreProcessing-app" }, "HostName":{ "description":"The host name or server URL where the services are running.", "type":"string", "example":"example.com" }, "ServiceName":{ "description":"The service name.", "type":"string", "example":"Metric Engine" }, "FailoverType":{ "description":"The failover type.", "type":"string", "example":"Cluster" }, "State":{ "description":"The indicator of the failover service state.", "type":"string", "example":"Running" }, "StateIcon":{ "description":"The icon for representing the state of the services.", "type":"string", "example":"OrbGreenUp.png" }, "ClusterID":{ "description":"The cluster ID specified for failover.", "type":"integer", "example":"2" }, "ServiceID":{ "description":"The service ID.", "type":"integer", "example":"321" }, "ProgName":{ "description":"The program name.", "type":"string", "example":"bin/MetricEngine" } } }, "brokerRenderTypesRead":{ "type":"object", "properties":{ "RenderTypeID":{ "description":"The render type ID.", "type":"integer", "example":"12" }, "RenderTypeName":{ "description":"The render type name.", "type":"string", "example":"exampleName" }, "ExtraInfo":{ "description":"Any extra information.", "type":"string", "example":"fieldName: coreLib" }, "DisplayName":{ "description":"The display name.", "type":"string", "example":"Example Name" } } }, "brokerRenderTypesReadForSelect":{ "properties":{ "RenderTypeID":{ "description":"The render type ID.", "type":"integer", "example":"12" }, "RenderTypeName":{ "description":"The render type name.", "type":"string", "example":"exampleName" } }, "type":"object" }, "brokerApplicationConfigTypesRead":{ "type":"object", "properties":{ "BrokerApplicationConfigName":{ "description":"The application configuration name.", "type":"string", "example":"LogLevel" }, "BrokerApplicationConfigTypeID":{ "description":"The application configuration type ID.", "type":"integer", "example":1 }, "RenderTypeID":{ "description":"The render type ID.", "type":"integer", "example":"12" }, "RenderTypeName":{ "description":"The render type name.", "type":"string", "example":"exampleName" }, "RenderType":{ "description":"The render type.", "type":"string", "example":"exampleType" }, "DisplayName":{ "description":"The display name.", "type":"string", "example":"DisplayNameExample" }, "icon":{ "description":"The icon representing the configuration state.", "type":"string", "example":"icon.png" } } }, "brokerApplicationConfigTypesCreate":{ "type":"object", "properties":{ "BrokerApplicationConfigName":{ "description":"The application configuration name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"LogLevel" }, "RenderTypeID":{ "description":"The render type ID.", "type":"integer", "example":"12" } } }, "brokerServersRead":{ "type":"object", "properties":{ "ServerID":{ "description":"The server ID.", "type":"integer", "example":"1" }, "PrimaryServerID":{ "description":"The primary server ID if this server is redundant.", "type":"integer", "example":"2" }, "ServerPlatformName":{ "description":"The server platform name.", "type":"string", "example":"EXL8" }, "CustomName":{ "description":"The custom name of the server.", "type":"string", "example":"CustomServer" }, "ServerHostFQDN":{ "description":"The server host FQDN making request.", "type":"string", "example":"server.com" }, "IsPresentation":{ "description":"Whether the server is a presentation server or not.", "type":"string", "example":"No" }, "IsDatabase":{ "description":"Whether the server is a database server or not.", "type":"string", "example":"No" }, "BootTime":{ "description":"The boot time represented as a Unix timestamp.", "type":"string", "example":"1689091296" }, "ServerCategoryID":{ "description":"The server category ID.\nAllowed Values:\n", "type":"integer", "example":"1" }, "ServerCategoryName":{ "description":"The primary role of the server. \n\nPossible Values: \n", "type":"string", "example":"Presentation" }, "Timezone":{ "description":"The server timezone.", "type":"string", "example":"GMT+5:30" }, "ZoneID":{ "description":"The zone ID.", "type":"integer", "example":"1" }, "LogRotateCount":{ "description":"The number of rotated logs to keep on the server.", "type":"integer", "example":"5" }, "LogRotateSize":{ "description":"The minimum size in megabytes of the logs before rotation on the server.", "type":"number", "example":"50" }, "BrokerLogLevel":{ "description":"The log level of the broker on the server.\nAllowed Values:\n", "type":"integer", "example":"0" }, "BrokerThreads":{ "description":"The broker worker threads on the server.", "type":"integer", "example":"20" }, "StatusID":{ "description":"The server status ID. Either 0 (disabled) or 1 (enabled).", "type":"integer", "example":"1" }, "Version":{ "description":"The version of the application under use.", "type":"string", "example":"6.0.4.0.0" }, "State":{ "description":"The server state.", "type":"string", "example":"Unknown" }, "RedundantServerCount":{ "description":"The number of redundant servers.", "type":"string", "example":"2" }, "roles":{ "$ref":"#/components/schemas/roles" }, "subroles":{ "$ref":"#/components/schemas/subroles" } } }, "brokerServersUpdate":{ "type":"object", "properties":{ "ServerHostFQDN":{ "description":"The host FQDN of the server making the request.", "type":"string", "example":"server.com" }, "ServerPlatformName":{ "description":"The server platform name.", "type":"string", "example":"EXL8" }, "BootTime":{ "description":"The boot time represented as Unix timestamp.", "type":"string", "example":"1689091296" }, "CustomName":{ "description":"The server custom name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"CustomServer" }, "PrimaryServerID":{ "description":"The primary server ID if this server is redundant.", "type":"integer", "example":"2" }, "Timezone":{ "description":"The server timezone.", "type":"string", "example":"GMT+5:30" }, "LogRotateCount":{ "description":"The number of rotated logs to keep on the server.", "type":"integer", "example":"5" }, "LogRotateSize":{ "description":"The minimum size in megabytes of the logs before rotation on the server.", "type":"number", "example":"50" }, "BrokerLogLevel":{ "description":"The log level of broker on the server.\nAllowed Values:\n", "type":"integer", "example":"0" }, "BrokerThreads":{ "description":"The broker worker threads on the server.", "type":"integer", "example":"20" }, "StatusID":{ "description":"The server status ID. Either 0 (disabled) or 1 (enabled).", "type":"integer", "example":"1" } } }, "roles":{ "description":"The array of server roles.", "type":"array", "items":{ "type":"object", "properties":{ "id":{ "description":"The server role ID.", "type":"integer", "example":2 }, "role":{ "description":"The role name.", "type":"string", "example":"Cluster" }, "subrole":{ "description":"The sub role name.", "type":"string", "example":"Internal" }, "version":{ "description":"The version of the application under use.", "type":"string", "example":"6.0.4.0.0" }, "serverID":{ "description":"The server ID.", "type":"integer", "example":4 }, "selected":{ "description":"Whether the server role is selected or not.", "type":"boolean", "example":1 } } } }, "subroles":{ "description":"The object denoting different main server roles and their respective sub roles.", "type":"object", "properties":{ "Cluster":{ "description":"The array of available sub roles for the main cluster server role.", "type":"array", "items":{ "type":"string" } }, "Collection":{ "description":"The array of available sub roles for the main collection server role.", "type":"array", "items":{ "type":"string" } }, "Database":{ "description":"The array of available sub roles for the main server role database.", "type":"array", "items":{ "type":"string" } }, "Presentation":{ "description":"The array of available sub roles for the main presentation server role.", "type":"array", "items":{ "type":"string" } }, "Processing":{ "description":"The array of available sub roles for the main processing server role.", "type":"array", "items":{ "type":"string" } }, "Vision":{ "description":"The array of available sub roles for the main Vision server role.", "type":"array", "items":{ "type":"string" } } } }, "brokerServersReadInstallStatus":{ "type":"object", "properties":{ "ServerID":{ "description":"The server ID.", "type":"integer", "example":"1" }, "status":{ "description":"The server role status that follows the format RoleStatus::RoleSetName::RoleName::SubRoleName::RoleStatusText.", "type":"string", "example":"6::Assure1::Cluster::Master::,,6::Assure1::Collection::Core::" }, "total":{ "description":"The total number of installed server roles mentioned in the status property.", "type":"integer", "example":"2" } } }, "brokerServersUpdateServerRoles":{ "type":"array", "items":{ "type":"object", "properties":{ "id":{ "description":"The database ID.", "type":"string", "example":"model-2" }, "role":{ "description":"The name of the role to update a sub role for.", "type":"string", "example":"Presentation" }, "selected":{ "description":"Whether the sub role should be selected (added) (true) or deselected (removed) (false).", "type":"boolean", "example":false }, "ServerHostFQDN":{ "description":"The server host FQDN.", "type":"string", "example":"server.example.com" }, "serverID":{ "description":"The server ID.", "type":"integer", "example":1 }, "subrole":{ "description":"The name of the sub role to select or de-select.", "type":"string", "example":"Internal" }, "version":{ "description":"The version of the server.", "type":"string", "example":"6.0.4" } } } }, "brokerServicesRead":{ "properties":{ "BrokerServiceID":{ "description":"The service ID.", "type":"integer", "example":"1" }, "ServerID":{ "description":"The server ID to which the service belongs.", "type":"integer", "example":"1" }, "ServerName":{ "description":"The server name.", "type":"string", "example":"example.com" }, "PackageName":{ "description":"The package name.", "type":"string", "example":"presentation-app" }, "ServiceName":{ "description":"The service reference name.", "type":"string", "example":"Data backup" }, "ServiceDescription":{ "description":"The optional service human-readable description.", "type":"string", "example":"This is an example description" }, "ServiceProgram":{ "description":"The service program file location and the name relative to the Unified Assurance install directory.", "type":"string", "example":"/opt/assure1" }, "ServiceArguments":{ "description":"The optional service arguments.", "type":"string", "example":"--ssl-ca=/ssl/BundleCA.crt" }, "FailoverType":{ "description":"The failover type ID.\nAllowed Values:\n", "type":"integer", "example":"0" }, "FailoverTypeName":{ "description":"The failover type name.", "type":"string", "example":"Standalone" }, "ClusterID":{ "description":"The cluster ID specified for redundancy.", "type":"integer", "example":"0" }, "PrimaryServiceID":{ "description":"The primary service ID specified for failover.", "type":"integer", "example":"0" }, "StatusID":{ "description":"The server status ID. Either 0 (disabled) or 1 (enabled).", "type":"integer", "example":"0" }, "Status":{ "description":"The status, based on the value of the StatusID property. When StatusID is 0, Status is Disabled. When StatusID is 1, Status is Enabled.", "type":"string", "example":"Disabled" }, "StatusIcon":{ "description":"The status image name based on the the statusID. If the statusID is 0, then the StatusIcon is OrbRed.png. If the statusID is 1, then the StatusIcon is OrbGreen.png.", "type":"string", "example":"OrbRed.png" }, "Privileged":{ "description":"Whether the process should be run as a privileged user (1) or not (0).", "type":"integer", "example":"0" }, "Last PID":{ "description":"The last process ID of the running service.", "type":"integer", "example":"4404" }, "PrimaryServerID":{ "description":"The database ID that identifies the primary server of the given server type (presentation, collection, database) in Assure1.Servers table.", "type":"integer", "example":"1" }, "PrimaryServiceServerID":{ "description":"The server ID of the server primarily responsible for the service.", "type":"integer", "example":"1", "nullable":true }, "Decouple":{ "description":"Allows for different combinations of primary/backup service pairings or pairing services across servers that are not tied together", "type":"boolean", "example":"1" }, "ApplicationConfig":{ "description":"The array of JSON objects with the configuration values for the service.", "type":"array", "items":{ "type":"object", "properties":{ "Required":{ "description":"Whether the configuration value can be left blank or not.", "type":"boolean", "example":0 }, "BrokerApplicationConfigName":{ "description":"Name of the configuration option.", "type":"string", "example":"LogLevel" }, "BrokerApplicationConfigValue":{ "description":"The value saved for the configuration option.", "type":"string", "example":"Error" }, "BrokerApplicationConfigTypeID":{ "description":"The broker application configuration type ID.", "type":"integer", "example":1 } } } }, "State":{ "description":"The service state.", "type":"string", "example":"Running" }, "StateIcon":{ "description":"The icon representing the service state.", "type":"string", "example":"OrbGreenUp.png" } }, "type":"object" }, "brokerServicesCreate":{ "properties":{ "ServerID":{ "description":"The server ID specified for the service association.", "type":"integer", "example":"1" }, "PackageName":{ "description":"The package name.", "type":"string", "example":"presentation-app" }, "ServiceName":{ "description":"The service reference name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Data backup" }, "ServiceDescription":{ "description":"The optional service human-readable description.", "type":"string", "example":"This is an example description" }, "ServiceProgram":{ "description":"The service program file location and name relative to the Unified Assurance install directory.", "type":"string", "example":"/opt/assure1" }, "ServiceArguments":{ "description":"The optional service program arguments.", "type":"string", "example":"--ssl-ca=/ssl/BundleCA.crt" }, "FailoverType":{ "description":"The failover type ID.\nAllowed Values:\n", "type":"integer", "example":"0" }, "PrimaryServiceID":{ "description":"The primary service ID specified for failover.", "type":"integer", "example":"0" }, "ClusterID":{ "description":"The cluster ID specified for redundancy.", "type":"integer", "example":"0" }, "StatusID":{ "description":"The service status ID. Either 0 (disabled) or 1 (enabled).", "type":"integer", "example":"0" }, "Privileged":{ "description":"Whether the process should be run as a privileged user (1) or not (0).", "type":"integer", "example":"0" }, "ApplicationConfig":{ "description":"The array of JSON objects with the configuration values for the service.", "type":"array", "items":{ "type":"object", "properties":{ "Required":{ "description":"Whether the configuration value can be left blank or not.", "type":"boolean", "example":0 }, "BrokerApplicationConfigName":{ "description":"The name of the configuration option.", "type":"string", "example":"LogLevel" }, "BrokerApplicationConfigValue":{ "description":"The value saved for the configuration option.", "type":"string", "example":"Error" }, "BrokerApplicationConfigTypeID":{ "description":"The broker application configuration type ID.", "type":"integer", "example":1 } } } } }, "type":"object" }, "brokerServicesReadForSelect":{ "properties":{ "BrokerServiceID":{ "description":"The ID of the broker service.", "type":"integer", "example":"1" }, "ServiceName":{ "description":"The name of the service.", "type":"string", "example":"Backup" } }, "type":"object" }, "brokerServicesReadStates":{ "type":"object", "properties":{ "BrokerServiceID":{ "description":"The ID of the broker service.", "type":"integer", "example":"1" }, "State":{ "description":"The indicator of the service state.", "type":"string", "example":"Running" }, "StateIcon":{ "description":"The icon representing the service state.", "type":"string", "example":"OrbGreenUp.png" } } }, "configActionsRead":{ "type":"object", "properties":{ "ActionCount":{ "description":"The number of actions to be executed.", "type":"integer", "example":"1" }, "ActionName":{ "description":"The descriptor for the group of actions to be run.", "type":"string", "example":"Example Action Name" }, "Actions":{ "$ref":"#/components/schemas/Actions" }, "ConfigActionProfileID":{ "description":"The configuration action profile ID.", "type":"integer", "example":"1001" }, "ResultTimeout":{ "description":"The timeout for all commands.", "type":"integer", "example":"30" } } }, "Actions":{ "type":"array", "items":{ "type":"object", "properties":{ "ActionOrder":{ "description":"The 0-based order to run commands.", "type":"integer", "example":1 }, "ConfigActionProfileID":{ "description":"The ID linking the action back to the parent actions profile.", "type":"integer", "example":2 }, "DisplayActionOutput":{ "description":"Whether to save the output of a command or not.", "type":"boolean", "example":0 }, "ReadAction":{ "description":"For Telnet actions only. The prompt to use before running the command. The default is #.", "type":"string", "example":"Example Read Action" }, "WriteAction":{ "description":"The command to run.", "type":"string", "example":"Example Write Action" } } } }, "configActionsCreate":{ "properties":{ "ActionName":{ "description":"The action name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Example Action Name" }, "ResultTimeout":{ "description":"The timeout for all commands.", "type":"integer", "example":"30" }, "Actions":{ "$ref":"#/components/schemas/Actions" } } }, "configActionsReadForSelect":{ "properties":{ "ConfigActionProfileID":{ "description":"The configuration action profile ID.", "type":"integer", "example":"1001" }, "ActionProfileName":{ "description":"The action profile name.", "type":"string", "example":"SSH Actions" } } }, "configCollectionsRead":{ "properties":{ "ConfigCollectionID":{ "description":"The configuration collection ID.", "type":"integer", "example":"1003" }, "DeviceName":{ "description":"The device name. Most commonly, this is the host FQDN.", "type":"string", "example":"server.domain.com" }, "DeviceZoneName":{ "description":"The device zone name.", "type":"string", "example":"Default First Zone" }, "ProfileName":{ "description":"The profile name.", "type":"string", "example":"SSH Profile" }, "ActionName":{ "description":"The action name.", "type":"string", "example":"Example Action Name" }, "StatusID":{ "description":"The configuration collection status ID. Either 0 (disabled) or 1 (enabled).", "type":"integer", "example":"0" }, "Status":{ "description":"The status, based on the value of the StatusID property. When StatusID is 0, Status is Disabled. When StatusID is 1, Status is Enabled.", "type":"string", "example":"Disabled" }, "StatusIcon":{ "description":"The status image name based on the the statusID. If the statusID is 0, then the StatusIcon is OrbRed.png. If the statusID is 1, then the StatusIcon is OrbGreen.png.", "type":"string", "example":"OrbRed.png" }, "DeviceID":{ "description":"The device ID.", "type":"integer", "example":"303" }, "ConfigAgentProfileID":{ "description":"The configuration agent profile ID.", "type":"integer", "example":"1001" }, "ConfigActionProfileID":{ "description":"The configuration action profile ID.", "type":"integer", "example":"1002" } } }, "configCollectionsUpdate":{ "properties":{ "ConfigAgentProfileID":{ "description":"The configuration agent profile ID.", "type":"integer", "example":"1001" }, "ConfigActionProfileID":{ "description":"The configuration action profile ID.", "type":"integer", "example":"1002" }, "DeviceName":{ "description":"The device the collection pertains to.", "type":"string", "example":"Some Device" }, "DeviceZoneName":{ "description":"The name of the zone the device is in.", "type":"string", "example":"Default First Zone" }, "StatusID":{ "description":"The configuration collection status ID. Either 0 (disabled) or 1 (enabled).", "type":"integer", "example":"0" } } }, "configCollectionsCreate":{ "properties":{ "ConfigAgentProfileID":{ "description":"The configuration agent profile ID.", "type":"integer", "example":"1001" }, "ConfigActionProfileID":{ "description":"The configuration action profile ID.", "type":"integer", "example":"1002" }, "DeviceName":{ "description":"The device the collection pertains to.", "type":"string", "example":"Some Device" }, "DeviceZoneName":{ "description":"The name of the zone the device is in.", "type":"string", "example":"Default First Zone" }, "StatusID":{ "description":"The configuration collection status ID. Either 0 (disabled) or 1 (enabled).", "type":"integer", "example":"0" }, "Devices":{ "description":"The device ID array. Each collection must contain a unique combination of ConfigAgentProfileID, ConfigActionProfileID, and Devices. Specify only devices that are not already in a collection that has the same ConfigAgentProfileID and ConfigActionProfileID.", "type":"array", "example":"[50,19]" } } }, "configCollectionsReadForSelect":{ "properties":{ "ConfigCollectionID":{ "description":"The configuration collection ID.", "type":"integer", "example":"1001" }, "ConfigCollectionName":{ "description":"The configuration collection name. A combination of DeviceName: AgentProfileName, ActionProfileName.", "type":"string", "example":"SSH Actions" } } }, "configPoliciesRead":{ "properties":{ "ConfigDiscoProfileID":{ "description":"The profile ID specified for individual CRUD operations.", "type":"integer", "example":"1004" }, "ConfigDiscoProfileName":{ "description":"The policy name.", "type":"string", "example":"test" }, "Description":{ "description":"The policy description.", "type":"string", "example":"Example Description" }, "StatusID":{ "description":"The policy status ID. Either 0 (disabled) or 1 (enabled).", "type":"integer", "example":"0" }, "Status":{ "description":"The status, based on the value of the StatusID property. When StatusID is 0, Status is Disabled. When StatusID is 1, Status is Enabled", "type":"string", "example":"Disabled" }, "ConfigAgentProfileID":{ "description":"The configuration agent profile ID.", "type":"integer", "example":"1001" }, "ProfileName":{ "description":"The profile name.", "type":"string", "example":"SSH Profile" }, "ConfigActionProfileID":{ "description":"The action profile ID.", "type":"integer", "example":"1001" }, "ActionName":{ "description":"The action name.", "type":"string", "example":"SSH Action" }, "IPRange":{ "description":"The device IP range to apply the policy to.", "type":"string", "example":"192.168.1.0 - 192.168.1.255" }, "DeviceNameRegex":{ "description":"The regular expression to match with device names. Used to limit the policy to specific devices.", "type":"string", "example":"^(Device-[0-9]{3})$" }, "DeviceTypeCategoryName":{ "description":"The device type category name.", "type":"string", "example":"Server" }, "DeviceTypeCategoryID":{ "description":"The device type category ID.", "type":"integer", "example":"6" }, "DeviceMetaTypeID":{ "description":"The device meta type ID.", "type":"integer", "example":"5" }, "DeviceMetaTypeName":{ "description":"The device meta type name.", "type":"string", "example":"Example Name" }, "DeviceMetaTypeValue":{ "description":"The device meta type value.", "type":"string", "example":"Example Value" }, "DeviceTypeName":{ "description":"The device type name.", "type":"string", "example":"Example Name" }, "DeviceTypeID":{ "description":"The device type ID.", "type":"string", "example":"NONE" }, "StatusIcon":{ "description":"The status image name based on StatusID. If StatusID is 0, StatusIcon will be OrbRed.png. If StatusID is 1, StatusIcon will be OrbGreen.png.", "type":"string", "example":"OrbRed.png" } } }, "configPoliciesCreate":{ "properties":{ "ConfigDiscoProfileName":{ "description":"The policy name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"test" }, "Description":{ "description":"The policy description.", "type":"string", "example":"Example Description" }, "StatusID":{ "description":"The policy status ID. Either 0 (disabled) or 1 (enabled).", "type":"integer", "example":"0" }, "ConfigAgentProfileID":{ "description":"The configuration agent profile ID.", "type":"integer", "example":"1001" }, "ConfigActionProfileID":{ "description":"The action profile ID.", "type":"integer", "example":"1001" }, "IPRange":{ "description":"The device IP range to which the policy should be applied.", "type":"string", "example":"192.168.1.0 - 192.168.1.255" }, "DeviceNameRegex":{ "description":"The regular expression to match with device names. Used to limit the policy to specific devices.", "type":"string", "example":"^(Device-[0-9]{3})$" }, "DeviceTypeCategoryID":{ "description":"The device type category ID.", "type":"integer", "example":"6" }, "DeviceMetaTypeID":{ "description":"The device meta type ID.", "type":"integer", "example":"5" }, "DeviceMetaTypeValue":{ "description":"The device meta type value.", "type":"string", "example":"Example Value" }, "DeviceTypeID":{ "description":"The device type ID.", "type":"string", "example":"NONE" } } }, "configPoliciesReadForSelect":{ "properties":{ "ConfigDiscoProfileID":{ "description":"The profile ID specified for individual CRUD operations.", "type":"integer", "example":"1001" }, "ConfigDiscoProfileName":{ "description":"The policy name.", "type":"string", "example":"Test Policy" } } }, "configProfilesRead":{ "properties":{ "ProfileName":{ "description":"The profile name.", "type":"string", "example":"SSH Profile" }, "ProfileDescription":{ "description":"The profile description.", "type":"string", "example":"Example Description" }, "Message":{ "description":"Message", "type":"string", "example":"Example Message" }, "EmailAddresses":{ "description":"The email address.", "type":"string", "example":"abc@email.com" }, "ProfileStatus":{ "description":"Whether the profile is enabled (1) or disabled (0).", "type":"integer", "example":"1" }, "ConfigAgentProfileTypeName":{ "description":"The configuration agent profile type name.", "type":"string", "example":"SSH" }, "NotificationTemplate":{ "description":"The notification template ID.", "type":"integer", "example":"50" }, "NotificationProfile":{ "description":"The notification profile ID.", "type":"integer", "example":"51" }, "LoginPrompt":{ "description":"The login prompt.", "type":"string", "example":"Customized" }, "TelnetPort":{ "description":"The telnet port.", "type":"integer", "example":"23" }, "ProfileUser":{ "description":"The profile user.", "type":"string", "example":"Default" }, "ConfigAgentProfileTypeID":{ "description":"The configuration agent profile type ID. The possible values are 1 (SSH) and 2 (Telnet).", "type":"integer", "example":"1" } } }, "configProfilesCreate":{ "properties":{ "ProfileName":{ "description":"The profile name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"SSH Profile" }, "ProfileDescription":{ "description":"The profile description.", "type":"string", "example":"Example Description" }, "Message":{ "description":"Message", "type":"string", "example":"Example Message" }, "EmailAddresses":{ "description":"The email address.", "type":"string", "example":"abc@email.com" }, "ProfileStatus":{ "description":"Whether the profile is enabled (1 or disabled 0).", "type":"integer", "example":"1" }, "ConfigAgentProfileTypeName":{ "description":"The configuration agent profile type name.", "type":"string", "example":"SSH" }, "NotificationTemplate":{ "description":"The notification template ID.", "type":"integer", "example":"50" }, "NotificationProfile":{ "description":"The notification profile ID.", "type":"integer", "example":"51" }, "ProfileUser":{ "description":"The profile user.", "type":"string", "example":"Default" }, "ProfilePassword":{ "description":"The profile password.", "type":"string", "example":"myFakePassword" }, "ConfigAgentProfileTypeID":{ "description":"The configuration agent profile type ID. The possible values are 1 for SSH and 2 for Telnet.", "type":"integer", "example":"1" }, "TelnetPort":{ "description":"Only used when profile type is Telnet. The value can be anything between 1 to 65535.", "type":"integer", "example":"80" }, "LoginPrompt":{ "description":"Only used when profile type is Telnet. This is an optional field.", "type":"string", "example":"" } } }, "configProfilesReadForSelect":{ "properties":{ "ConfigAgentProfileID":{ "description":"The configuration agent profile type ID. The possible values are 1 (SSH) and 2 (Telnet).", "type":"integer", "example":"1" }, "AgentProfileName":{ "description":"The agent profile name.", "type":"string", "example":"SSH Profile" } } }, "configViewConfigsReadRevisionHistory":{ "properties":{ "RevisionID":{ "description":"The revision ID.", "type":"integer", "example":"2320" }, "RevisionName":{ "description":"The revision name.", "type":"string", "example":"Config Mgr Commit" } } }, "configViewConfigsReadFile":{ "properties":{ "FileName":{ "description":"The file name.", "type":"string", "example":"file.conf" }, "FileContents":{ "description":"The file contents with the configuration details.", "type":"string", "example":"localhost:server.com" } } }, "configViewConfigsReadDiff":{ "properties":{ "fromFile":{ "description":"The initial file before the changes were made.", "type":"string", "example":"Example File Contents" }, "toFile":{ "description":"The final file after the changes were made.", "type":"string", "example":"Example File Contents" } } }, "configViewConfigsReadView":{ "properties":{ "Revision":{ "description":"The revision ID.", "type":"integer", "example":"2340" }, "CommitDate":{ "description":"The commit date.", "type":"string", "example":"2023-03-15 10:59:09" }, "Username":{ "description":"The username.", "type":"string", "example":"admin" }, "Message":{ "description":"The message showing details like configuration changes.", "type":"string", "example":"Config Mgr Commit" } } }, "coreGlobalPropertiesCertificateWarning":{ "properties":{ "PropertyName":{ "description":"The property name.", "type":"string", "example":"CertificateAuthorityWarning" }, "PropertyValue":{ "description":"The property value.", "type":"integer", "example":"1" }, "Description":{ "description":"The description.", "type":"string", "example":"Example Description" } } }, "coreExecuteChangePasswordRequestBody":{ "properties":{ "NewPassword":{ "description":"The new password.", "type":"string", "example":"ExampleNewPassword" }, "RepeatNewPassword":{ "description":"The new password, repeated for confirmation.", "type":"string", "example":"ExampleNewPassword" }, "Username":{ "description":"The username to change the password for.", "type":"string", "example":"admin" }, "OldPassword":{ "description":"The old or expired password.", "type":"string", "example":"ExampleOldPassword" } } }, "SessionInfoRead":{ "properties":{ "UserID":{ "description":"The user ID.", "type":"integer", "example":"1001" }, "UserGroupID":{ "description":"The user group ID.", "type":"integer", "example":"1" }, "Username":{ "description":"The username.", "type":"string", "example":"admin" }, "FullName":{ "description":"The full name of the user.", "type":"string", "example":"Example Name" }, "PasswordExpiration":{ "description":"The time when the password will expire, in seconds from epoch time.", "type":"integer", "example":"2147483647" }, "SupportUsername":{ "description":"The support username.", "type":"string", "example":"example username" }, "SupportPassword":{ "description":"The support password.", "type":"string", "example":"example password" }, "EmailAddress":{ "description":"The email address.", "type":"string", "example":"example@example.com" }, "SamlUser":{ "description":"Whether the user is a SAML user (1) or not (0).", "type":"boolean", "example":false }, "PermissionIDs":{ "description":"A JSON object with IDs of all the permissions that the user has.", "type":"object", "example":{ "AAAAuthTypes":"10021", "brokerServices":"11008" } }, "Permissions":{ "description":"A JSON object with subobjects for the operations, such as create, update, delete, that are available to the user for each endpoint.", "type":"object", "example":{ "AAA":{ "AuthTypes":{ "read":true, "create":false }, "Permissions":{ "read":true, "create":false } } } }, "Preferences":{ "description":"An object showing the user preferences.", "type":"object", "example":{ "PageSize":"1000", "RefreshRate":"60" } }, "ThemeDir":{ "description":"The theme selected by the user.", "type":"string", "example":"light" }, "Locale":{ "description":"The user's regional and language preferences.", "type":"string", "example":"en_US" }, "Properties":{ "description":"A JSON object with restrictive property IDs.", "type":"object", "example":{ "RestrictiveDeviceGroupId":"1" } }, "TZ":{ "description":"The user's time zone, represented in an abbreviated format depicting offset from UTC.", "type":"string", "example":"CST6CDT" } } }, "coreGlobalPropertiesRead":{ "properties":{ "PropertyID":{ "description":"The property ID.", "type":"integer", "example":"1" }, "PropertyName":{ "description":"The property name.", "type":"string", "example":"RestrictiveDeviceGroupID" }, "PropertyValue":{ "description":"The property value.", "type":"integer", "example":"1" }, "Description":{ "description":"The property's description.", "type":"string", "example":"Example Description" } } }, "coreIcons":{ "properties":{ "IconID":{ "description":"The icon ID.", "type":"string", "example":"example/icon.png" }, "IconPath":{ "description":"The path to the directory where the icon is stored.", "type":"string", "example":"/example/path/icon.png" }, "IconName":{ "description":"The icon name.", "type":"string", "example":"Example Icon" } } }, "coreLocalesReadForSelect":{ "properties":{ "LocaleValue":{ "description":"The locale value.", "type":"string", "example":"en_US" }, "LocaleName":{ "description":"The locale name.", "type":"string", "example":"en_US" } } }, "coreLocalesRead":{ "properties":{ "ID":{ "description":"The locale ID.", "type":"string", "example":"en_US" }, "Lang":{ "description":"A key-value pair. The key is an English word and the value is the corresponding word in another language.", "type":"object", "example":{ } } } }, "coreThemes":{ "properties":{ "ThemeValue":{ "description":"The theme value.", "type":"string", "example":"Example Theme Value" }, "ThemeName":{ "description":"The theme name.", "type":"string", "example":"Example Theme Name" } } }, "coreTimeZones":{ "properties":{ "TimeZoneName":{ "description":"The time zone name.", "type":"string", "example":"US/Central" }, "TimeZoneValue":{ "description":"The time zone value.", "type":"string", "example":"US/Central" } } }, "coreBatchExecuteRequestBody":{ "properties":{ "Actions":{ "description":"The array of objects with API requests defined in them.", "type":"array", "items":{ "type":"object", "properties":{ "api":{ "description":"The API endpoint to run a request against.", "type":"string", "example":"broker/services" }, "method":{ "description":"The method of the API to call. Allowed values are:\n", "type":"string", "example":"read" }, "data":{ "description":"Parameters with static values to use in the request path, query, or body.", "type":"object", "example":{ "limit":1, "filter":{ "property":"ServerHostFQDN", "value":"host.example.com", "operator":"eq" } } }, "dynamicData":{ "description":"Parameters with dynamic values to use in the path, query, or body. These parameters are dynamically defined as the batch is run. You use variables created in the response property of a previous request in the dynamicData of subsequent requests in the batch. For example, if a previous request in the batch saved a server ID returned in its response, you could use that server ID in the body, path, or query of the subsequent request.", "type":"object", "example":{ "filter":{ "property":"ServerID", "value":"$ServerID", "operator":"eq" } } }, "response":{ "description":"The array of field-value pairs to populate with values from the API response. For example, you could save the server ID returned in the response of a request to get server details based on the web FQDN, and use the server ID in the dynamicData of a subsequent request in the batch.", "type":"array", "items":{ "type":"object", "properties":{ "varName":{ "description":"The name of the variable to store response values in for use in later requests in the same batch. Choose a simple, logical name. For example, if the response contains a list of devices, and you want to save the device IDs to use in another request, you could call this DeviceIDList.", "type":"string", "example":"DeviceIDList" }, "fieldName":{ "description":"The name of the field from the response whose values should be stored in the variable. This must match a field in the response. For example, if the response contains a list of devices, and you want to save the device IDs to use in another request, use DeviceID.", "type":"string", "example":"DeviceID" }, "varType":{ "description":"Whether the variable contains a list of values (array) or a single value (single). For example, if the response contains a list of devices, and you want to save all of the device IDs to use in another request with a forEach loop, use array. If the response contains a single device, use single.", "type":"string", "example":"array", "enum":[ "single", "array" ] } } } }, "forEach":{ "description":"An object defining a loop over an array. For each item in the array variable referenced in the from property:
  1. Store the value in a new variable named in the varName property
  2. Run the API request, using the new variable, referenced in the dynamicData property.
", "type":"object", "properties":{ "from":{ "description":"The name of a variable defined in the response property of a previous API request in the same batch. This variable contains the array to run the request on.", "type":"string", "example":"DeviceIDList" }, "varName":{ "description":"The name of a new variable to store the value from each entry in the array referenced in the from property. Use this variable in the dynamicData property for the current action. The value is updated dynamically as the loop works through each item in the array.", "type":"string", "example":"DeviceID" } } } } } } } }, "coreBatchExecuteResponseBody":{ "properties":{ "api":{ "description":"The API endpoint from which the response is returned.", "type":"string", "example":"/broker/services" }, "method":{ "description":"The method of the API that was called.", "type":"string", "example":"read" }, "request":{ "description":"An object that contains the combined properties from both data and dynamicData that were sent in the request body. If data and dynamicData contain the same keys, the values are combined into an array. Any variables referenced in the request are replaced by their actual values in the response. In the example, ApplicationConfig came from data in the request, id came from dynamicData, and the value of id was dynamically updated from a variable to an actual value.", "type":"object", "example":{ "ApplicationConfig":{ "BrokerApplicationConfigTypeID":2, "BrokerApplicationConfigName":"LogLevel", "BrokerApplicationConfigValue":4, "Required":1 }, "id":1234 } }, "response":{ "description":"The response object from the API.", "type":"object", "properties":{ "success":{ "description":"Whether the operation was a success (true) or a failure (false).", "type":"boolean", "example":true }, "message":{ "description":"The response message.", "type":"string", "example":"Updated record" }, "data":{ "description":"The response body.", "type":"object", "example":{ "ApplicationConfig":{ "BrokerApplicationConfigTypeID":2, "BrokerApplicationConfigName":"LogLevel", "BrokerApplicationConfigValue":4, "Required":1 }, "id":1234 } } }, "example":{ "success":true, "message":"Updated record", "data":{ "ApplicationConfig":{ "BrokerApplicationConfigTypeID":2, "BrokerApplicationConfigName":"LogLevel", "BrokerApplicationConfigValue":4, "Required":1 }, "id":1234 } } } } }, "dashboardDashboardsRead":{ "type":"object", "properties":{ "DashboardTypeID":{ "description":"Dashboard Type ID", "type":"integer", "example":"1" }, "PanelParams":{ "description":"A JSON string of parameters relating to the panel.", "type":"string", "example":"[{\"PartTypeID\":\"6\",\"width\":100,\"DashboardName\":\"Basic Services Dashboard\",\"InitialExpansion\":\"0\",\"InitialExpansionDynamic\":\"1\",\"InitialView\":\"Summary\",\"InitialViewDynamic\":\"1\",\"LinkTarget\":\"NewWindow\",\"LinkTargetDynamic\":\"1\",\"PanelName\":\"Test\",\"PartTypeID\":\"6\",\"RefreshRate\":\"\",\"RootID\":\"root\",\"RootIDDynamic\":\"1\",\"ShowToolbar\":\"1\",\"SummaryInitialExpansion\":\"all\",\"SummaryInitialExpansionDynamic\":\"1\",\"SummaryNodeSize\":\"Normal\",\"SummaryNodeSizeDynamic\":\"1\",\"SummaryTreeType\":\"LeftToRight\",\"SummaryTreeTypeDynamic\":\"1\",\"TimeRangeDynamic\":\"1\",\"TimeRange\":\"now-24h..now..\",\"Width\":\"1\",\"recordID\":\"DashboardsDashboard\",\"width\":\"1\",\"AutoHeight\":1}]" }, "HideHeader":{ "description":"Whether the header should be shown when the dashboard is rendered (1) or not (0).", "type":"integer", "example":"0" }, "ReloadRate":{ "description":"The number of seconds between automatically refreshing the content of panels on the dashboard. Use null to prevent the dashboard from auto refreshing.", "type":"integer", "nullable":true, "example":null }, "MaxColumns":{ "description":"The maximum number of columns the dashboard will render before wrapping additional panels onto the next row.", "type":"integer", "example":"4" }, "DashboardID":{ "description":"The dashboard ID.", "type":"integer", "example":"12" }, "DashboardName":{ "description":"The dashboard name.", "type":"string", "example":"Basic Services Dashboard" }, "OwnerUserID":{ "description":"The ID of the user that owns the dashboard. This can never be an externally-authenticated transient user. 0 means it is public to all users in the owning group.", "type":"integer", "example":"0" }, "OwnerUserGroupID":{ "description":"The owner user group ID.", "type":"integer", "example":"0" }, "DashboardTypeName":{ "description":"The dashboard type name.", "type":"string", "example":"Basic" }, "Owner":{ "description":"The name of the owner.", "type":"string", "example":"[Public to All Users and Groups]" }, "Viewers":{ "description":"The list of user groups that can view the dashboard.", "type":"array", "items":{ "type":"object", "properties":{ "UserGroupID":{ "description":"The user group ID.", "type":"integer" }, "UserGroupName":{ "description":"The user group name.", "type":"string" } } }, "example":[ ] } } }, "dashboardDashboards":{ "type":"object", "properties":{ "DashboardName":{ "description":"The dashboard name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Basic Services Dashboard" }, "OwnerUserID":{ "$ref":"#/components/schemas/dashboardDashboardsRead/properties/OwnerUserID" }, "OwnerUserGroupID":{ "$ref":"#/components/schemas/dashboardDashboardsRead/properties/OwnerUserGroupID" }, "HideHeader":{ "$ref":"#/components/schemas/dashboardDashboardsRead/properties/HideHeader" }, "Viewers":{ "$ref":"#/components/schemas/dashboardDashboardsRead/properties/Viewers" }, "PanelParams":{ "$ref":"#/components/schemas/dashboardDashboardsRead/properties/PanelParams" }, "ReloadRate":{ "$ref":"#/components/schemas/dashboardDashboardsRead/properties/ReloadRate" }, "MaxColumns":{ "$ref":"#/components/schemas/dashboardDashboardsRead/properties/MaxColumns" } } }, "dashboardDashboardsReadParts":{ "type":"object", "properties":{ "PanelTypeID":{ "description":"The panel Type ID.", "type":"integer", "example":"17" }, "PanelTypeName":{ "description":"The panel type name.", "type":"string", "example":"View Config" }, "pkg":{ "description":"The Unified Assurance package that the part belongs to.", "type":"string", "example":"config" }, "PartDefinition":{ "description":"The configuration definition that the dashboard needs in order to render the part.", "type":"string", "example":"{17: {viewTemplate: {title: \"View Config\",form: \"Config.viewConfigs.crud.view.ConfigsPanelForm\",iconCls: \"fa-eye\",dockedItems: [],items: [{xtype: \"configspanelview\"}]}}}" } } }, "dashboardDashboardsReadForSelect":{ "type":"object", "properties":{ "DashboardID":{ "$ref":"#/components/schemas/dashboardDashboardsRead/properties/DashboardID" }, "DashboardName":{ "$ref":"#/components/schemas/dashboardDashboardsRead/properties/DashboardName" }, "DashboardGroupID":{ "description":"The dashboard group the dashboard belongs to.", "type":"integer", "example":null, "nullable":true }, "RenderType":{ "description":"The render type.", "type":"string", "example":"combo;DashboardID;DashboardName;/api/dashboard/dashboards/readForSelect" } } }, "dashboardDashboardGroupsRead":{ "type":"object", "properties":{ "DashboardGroupID":{ "description":"The dashboard group ID.", "type":"integer", "example":"1" }, "DashboardGroupName":{ "description":"The dashboard group name.", "type":"string", "example":"Root" }, "ParentDashboardGroupID":{ "description":"The parent dashboard group ID.", "type":"integer", "example":"1" }, "data":{ "description":"The list of children dashboard group.", "type":"array", "items":{ "type":"object" }, "example":[ { "DashboardGroupID":"1000", "DashboardGroupName":"Adhoc", "ParentDashboardGroupID":"1", "cls":"folder" } ] }, "cls":{ "type":"string", "example":"folder" }, "total":{ "description":"The total number of children.", "type":"integer", "example":1 } } }, "dashboardDashboardGroupsReadByID":{ "type":"object", "properties":{ "DashboardGroupID":{ "description":"The dashboard group ID.", "type":"integer", "example":"1" }, "DashboardGroupName":{ "description":"The dashboard group name.", "type":"string", "example":"Adhoc" }, "ParentDashboardGroupID":{ "description":"The parent dashboard group ID.", "type":"integer", "example":"1" }, "Dashboards":{ "description":"The list of dashboard IDs.", "type":"array", "items":{ "type":"object", "properties":{ "DashboardID":{ "description":"The dashboard ID.", "type":"integer" }, "DashboardName":{ "description":"The dashboard name.", "type":"string" } } }, "example":[ { "DashboardID":"27", "DashboardName":"Adhoc Metric Dashboard" }, { "DashboardID":"28", "DashboardName":"Adhoc Event Dashboard" }, { "DashboardID":"39", "DashboardName":"Adhoc View Config Dashboard" }, { "DashboardID":"29", "DashboardName":"Adhoc Graph Dashboard" } ] } } }, "dashboardDashboardGroups":{ "type":"object", "properties":{ "DashboardGroupName":{ "description":"The name of the dashboard group.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Adhoc Dashboards" }, "ParentDashboardGroupID":{ "$ref":"#/components/schemas/dashboardDashboardGroupsReadByID/properties/ParentDashboardGroupID" }, "Dashboards":{ "description":"The list of dashboard IDs.", "type":"array", "items":{ "type":"integer" }, "example":[ 27, 28, 39, 29 ] }, "Remove":{ "description":"Whether to remove the dashboard from other dashboard groups (1) or not (0).", "type":"boolean", "example":1 } } }, "dashboardDashboardGroupsReadForTree":{ "type":"object", "properties":{ "DashboardGroupID":{ "description":"The dashboard group ID.", "type":"integer", "example":"1" }, "DashboardGroupName":{ "description":"The dashboard group name.", "type":"string", "example":"Root" }, "leaf":{ "description":"Whether it is a leaf (true) or not (false).", "type":"boolean", "example":false }, "iconCls":{ "description":"The CSS class for icons.", "type":"string", "example":"x-tree-icon-parent" } } }, "databaseDatabasesRead":{ "type":"object", "properties":{ "DatabaseID":{ "description":"The database ID for individual CRUD operations.", "type":"integer", "example":"1002" }, "DatabaseName":{ "description":"The database display name.", "type":"string", "example":"Primary Graph Database on someone.example.com" }, "FailoverTypeID":{ "description":"The failover type ID. Either 1 for a primary database or 2 for a backup or redundant database.", "type":"integer", "example":"1" }, "ShardID":{ "description":"The database shard ID.", "type":"integer", "example":"1" }, "DBType":{ "description":"The database type used in the connection string.\n The possible values are:\n ", "type":"string", "example":"Neo4j" }, "Description":{ "description":"The description of the database.", "type":"string", "example":"Graph database" }, "DBName":{ "description":"The database schema name.", "type":"string", "example":"Graph" }, "DBHost":{ "description":"The database FQDN host name.", "type":"string", "example":"someone.example.com" }, "DBPort":{ "description":"The database port. The default is 3306.", "type":"integer", "example":"7687" }, "Username":{ "description":"The database login username.", "type":"string", "example":"" }, "Timeout":{ "description":"The database connection timeout value in seconds. The default is 30.", "type":"integer", "example":"30" }, "StatusID":{ "description":"The database status ID. Either 0 (disabled) or 1 (enabled).", "type":"integer", "example":"1" }, "IsAssure1Database":{ "description":"Whether the database is a Unified Assurance database (1) or not (0). If the database name is Assure1, Event, Graph, Metric, or Vision, then it is a Unified Assurance database.", "example":"1" }, "Status":{ "description":"The status.", "type":"string", "example":"Enabled", "enum":[ "Enabled", "Disabled" ] }, "StatusIcon":{ "description":"The status icon.", "type":"string", "example":"OrbGreen.png", "enum":[ "OrbGreen.png", "OrbRed.png" ] }, "State":{ "description":"The state.", "type":"string", "example":"Loading..." }, "StateIcon":{ "description":"The state icon.", "type":"string", "example":"barSpinner.gif" } } }, "databaseDatabases":{ "type":"object", "properties":{ "ShardID":{ "$ref":"#/components/schemas/databaseDatabasesRead/properties/ShardID" }, "FailoverTypeID":{ "$ref":"#/components/schemas/databaseDatabasesRead/properties/FailoverTypeID" }, "DatabaseName":{ "description":"The database display name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Primary Graph Database on someone.example.com" }, "Description":{ "$ref":"#/components/schemas/databaseDatabasesRead/properties/Description" }, "DBType":{ "$ref":"#/components/schemas/databaseDatabasesRead/properties/DBType" }, "DBHost":{ "$ref":"#/components/schemas/databaseDatabasesRead/properties/DBHost" }, "DBName":{ "$ref":"#/components/schemas/databaseDatabasesRead/properties/DBName" }, "DBPort":{ "$ref":"#/components/schemas/databaseDatabasesRead/properties/DBPort" }, "Timeout":{ "$ref":"#/components/schemas/databaseDatabasesRead/properties/Timeout" }, "Username":{ "$ref":"#/components/schemas/databaseDatabasesRead/properties/Username" }, "Password":{ "description":"The new database login password.", "type":"string" }, "StatusID":{ "$ref":"#/components/schemas/databaseDatabasesRead/properties/StatusID" } } }, "databaseDatabasesReadStates":{ "type":"object", "properties":{ "DatabaseID":{ "$ref":"#/components/schemas/databaseDatabasesRead/properties/DatabaseID" }, "State":{ "description":"The state.", "type":"string", "example":"Unknown", "enum":[ "Running", "Stopped", "Re-syncing", "Unknown" ] }, "StateIcon":{ "description":"The state icon.", "type":"string", "example":"OrbGray.png", "enum":[ "OrbGreenUp.png", "OrbRedDown.png", "OrbOrange.png", "OrbGray.png" ] } } }, "databaseQueriesRead":{ "type":"object", "properties":{ "Description":{ "description":"The description of the query.", "type":"string", "example":"Devices in catalog with a blank DNS name" }, "QueryID":{ "description":"The query ID for individual CRUD operations.", "type":"integer", "example":"1000" }, "QueryName":{ "description":"The query name.", "type":"string", "example":"Devices Missing DNS" }, "QueryDBName":{ "description":"The database schema.", "type":"string", "example":"Assure1" }, "QueryShardID":{ "description":"The shard ID. The default is 1.", "type":"integer", "example":"1" }, "Query":{ "description":"The query SQL.", "type":"string", "example":"-- Blank DNS --\n SELECT D.DeviceID AS 'ID',\n D.CustomName AS 'Device Name',\n INET_NTOA(D.IPAddress) AS 'IP Address',\n FROM_UNIXTIME(D.TimestampAdded) AS 'First Found',\n FROM_UNIXTIME(D.TimestampLastFound) AS 'Last Found',\n FROM_UNIXTIME(D.TimestampModified) AS 'Last Modified',\n DTC.DeviceTypeCategoryName AS 'Category',\n DZ.DeviceZoneName AS 'Zone'\n FROM Devices AS D,\n DeviceTypeCategories AS DTC,\n DeviceZones AS DZ\n WHERE D.DeviceTypeCategoryID = DTC.DeviceTypeCategoryID\n AND D.DeviceZoneID = DZ.DeviceZoneID\n AND D.DNSName = ''\n ORDER BY D.CustomName ASC" }, "OwnerUserID":{ "description":"The owner's user ID.", "type":"integer", "example":"0" }, "OwnerUserGroupID":{ "description":"The owner's user group ID.", "type":"integer", "example":"0" }, "Owner":{ "description":"The ID of the user that owns the query. This can never be an externally-authenticated transient user. 0 means it is public to all users in the owning group.", "type":"string", "example":"[Public to All Users and Groups]" }, "Viewers":{ "description":"The list of user groups that can view.", "type":"array", "items":{ "type":"object", "properties":{ "UserGroupID":{ "description":"The user group ID.", "type":"integer" }, "UserGroupName":{ "description":"The user group name.", "type":"string" } } }, "example":[ ] }, "Tokens":{ "description":"The optional array of tokens or placeholders to dynamically replace when the query is run.", "type":"array", "items":{ "type":"object", "properties":{ "TokenName":{ "description":"The token name to replace.", "type":"string", "example":"DeviceName" }, "TokenIndex":{ "description":"The ID of the token in the tokens array.", "type":"integer", "example":"1" }, "DefaultValue":{ "description":"The value to replace the token with if no value is provided.", "type":"string", "example":"pg-someone.example.com" } } } } } }, "databaseQueries":{ "type":"object", "properties":{ "QueryName":{ "description":"The query name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Devices Missing DNS" }, "Description":{ "$ref":"#/components/schemas/databaseQueriesRead/properties/Description" }, "QueryDBName":{ "$ref":"#/components/schemas/databaseQueriesRead/properties/QueryDBName" }, "QueryShardID":{ "$ref":"#/components/schemas/databaseQueriesRead/properties/QueryShardID" }, "Query":{ "$ref":"#/components/schemas/databaseQueriesRead/properties/Query" }, "OwnerUserID":{ "$ref":"#/components/schemas/databaseQueriesRead/properties/OwnerUserID" }, "OwnerUserGroupID":{ "$ref":"#/components/schemas/databaseQueriesRead/properties/OwnerUserGroupID" }, "Viewers":{ "$ref":"#/components/schemas/databaseQueriesRead/properties/Viewers" }, "Tokens":{ "description":"Optional array of tokens, or placeholders, to be dynamically replaced when the query is used.", "type":"array", "items":{ "type":"object", "properties":{ "TokenName":{ "description":"The token name to replace.", "type":"string", "example":"DeviceName" }, "DefaultValue":{ "description":"The value to replace the token with if no value is provided.", "type":"string", "example":"pg-someone.example.com" }, "id":{ "description":"The unique ID of the token in the tokens array. The value is not important, but it must be unique.", "type":"string", "example":"Database.queries.crud.model.TokenModel-1" } } } } } }, "databaseQueriesReadForSelect":{ "type":"object", "properties":{ "QueryID":{ "$ref":"#/components/schemas/databaseQueriesRead/properties/QueryID" }, "QueryName":{ "$ref":"#/components/schemas/databaseQueriesRead/properties/QueryName" } } }, "databaseQueryTools":{ "type":"object", "properties":{ "QueryDatabaseID":{ "description":"The database ID. You must specify either QueryDBName or QueryDatabaseID. If you specify both, QueryDBName is used.", "type":"integer", "example":"1" }, "QueryDBName":{ "description":"The database name. You must specify either QueryDBName or QueryDatabaseID. If you specify both, QueryDBName is used.", "type":"string", "example":"Assure1" }, "QueryShardID":{ "description":"The shard ID.", "type":"integer", "example":"1" }, "QueryID":{ "description":"The query ID. You must specify either QueryName or QueryID. If you specify both, QueryName is used.", "type":"integer", "example":"1005" }, "QueryName":{ "description":"The query name, correlated to CoreDatabaseQueries.QueryName.", "type":"string" }, "Query":{ "description":"The query SQL.", "type":"string", "example":"SELECT d.DNSName,\n d.IPAddress,\n d.DeviceZoneID\n FROM Devices AS d\n WHERE d.DNSName != ''\n AND d.DeviceID NOT IN (SELECT DeviceID\n FROM DeviceInterfaces\n WHERE DeviceID = d.DeviceID)" }, "QueryLimit":{ "description":"The number of rows to select.", "type":"integer", "example":100 }, "Tokens":{ "description":"The JSON object with an array of name-value pairs to replace with values from the query.\n
For example, to get DeviceID and Metric ID with query 1234, use the following: <hostFQDN>/api/database/QueryTools/executeQuery?QueryID=1234&Tokens=[{\"name\":\"DeviceID\",\"value\":\"234\"},{\"name\":\"MetricID\",\"value\":\"345\"}]", "type":"array", "items":{ "type":"object" } } } }, "databaseQueryToolsResponseData":{ "type":"object", "properties":{ "DNSName":{ "description":"The DNS name.", "type":"string", "example":"someone.example.com" }, "IPAddress":{ "description":"The IP address.", "type":"string", "example":"1682824301" }, "DeviceZoneID":{ "description":"The device zone ID.", "type":"integer", "example":"1" } } }, "deviceDevices":{ "properties":{ "DNSName":{ "description":"The device DNS name. Sequences of integers optionally prefixed by a sign character, such as 12345, +123, -456, or 0888 are not supported. Hexadecimal, decimal, and exponential expressions are valid and are treated as a name. For example, 0xAD, 123e10, 33.44.", "type":"string" }, "DeviceStateID":{ "description":"The device state ID. Valid values are:\n", "type":"integer", "enum":[ 0, 1, 2, 3, 101, 102 ] }, "IPv4":{ "description":"The IPv4 address.", "type":"string" }, "IPv6":{ "description":"The IPv6 address in hex notation.", "type":"string" }, "DevicePriorityID":{ "description":"The device priority ID.", "type":"integer" }, "CustomName":{ "description":"The device custom name. Sequences of integers optionally prefixed by a sign character, such as 12345, +123, -456, or 0888 are not supported. Hexadecimal, decimal, and exponential expressions are valid and are treated as a name. For example, 0xAD, 123e10, 33.44.", "type":"string" }, "DeviceZoneID":{ "description":"The device zone ID.", "type":"integer" }, "DeviceTypeCategoryID":{ "description":"The device type category ID.", "type":"integer" }, "InitialDeviceGroupID":{ "description":"The initial device group ID.", "type":"integer" }, "DeviceSNMPAccessID":{ "description":"The SNMP access profile ID.", "type":"integer" }, "ParentDeviceID":{ "description":"The parent device ID for virtual devices.", "type":"integer" }, "GeoLocation":{ "description":"The GeoJSON point of device location (lon, lat).", "type":"string" }, "MetaData":{ "description":"The metadata object definitions for the device (DeviceMetaTypeID, MetaData).", "type":"array", "items":{ "type":"object" } }, "ShardID":{ "description":"The device shard ID. If database sharding is not configured, it defaults to 1.", "type":"integer" } }, "type":"object" }, "deviceDevicesRead":{ "properties":{ "DeviceID":{ "description":"The device ID.", "type":"integer", "example":"1" }, "DeviceName":{ "description":"The device name. This is created automatically in order of precedence based on CustomName, DNSName, SysName, IPv6Address, and IPAddress.", "type":"string", "example":"router.example.com" }, "IPv4":{ "description":"The IPv4 address.", "type":"string", "example":"192.0.2.1" }, "IPv6":{ "description":"The IPv6 address in hex notation.", "type":"string", "example":"2001:DB8::1" }, "FirstFound":{ "description":"The timestamp when the device was first discovered, in YYYY-MM-DD HH:MM:SS format.", "type":"string", "example":"2006-01-02 15:04:05" }, "LastModified":{ "description":"The timestamp when the device was last modified, in YYYY-MM-DD HH:MM:SS format.", "type":"string", "example":"2006-01-02 15:04:05" }, "LastFound":{ "description":"The timestamp when the device was last discovered, in YYYY-MM-DD HH:MM:SS format.", "type":"string", "example":"2006-01-02 15:04:05" }, "DevicePriorityID":{ "description":"The device priority ID.", "type":"integer", "example":"1" }, "ParentDeviceID":{ "description":"The parent device ID for virtual devices.", "type":"integer", "example":"0" }, "DeviceTypeCategoryID":{ "description":"The manually set device type category ID.", "type":"integer", "example":"1" }, "DeviceTypeName":{ "description":"The manually set device type category name.", "type":"string", "example":"Router" }, "DeviceTypeCategoryDiscoveredID":{ "description":"The automatically discovered device type category ID.", "type":"integer", "example":"1" }, "DeviceTypeCategoryDiscoveredName":{ "description":"The automatically discovered device type category name.", "type":"string", "example":"Router" }, "DeviceZoneID":{ "description":"The device zone ID.", "type":"integer", "example":"1" }, "DeviceStateID":{ "description":"The device state ID. Valid values are:\n", "type":"integer", "example":"1" }, "DeviceStatus":{ "description":"The device status.", "type":"string", "example":"new" }, "DeviceStatusIcon":{ "description":"The colour value for DeviceStatusID. \nThe possible values are:\n", "type":"string", "example":"green" }, "DNSName":{ "description":"The DNS name.", "type":"string", "example":"router1.example.com" }, "CustomName":{ "description":"The custom name.", "type":"string", "example":"My Custom Device" }, "DeviceZoneName":{ "description":"The device zone name.", "type":"string", "example":"Default First Zone" }, "ShardID":{ "description":"The device shard ID.", "type":"integer", "example":"1" }, "DeviceGroupName":{ "description":"The device group name.", "type":"string", "example":"root" }, "GeoLocation":{ "description":"The GeoJSON point of device location (lon, lat).", "type":"string", "example":"{\"type\": \"Point\", \"coordinates\": [0, 0]}" }, "DeviceSNMPAccessID":{ "description":"The SNMP access profile ID.", "type":"integer", "example":"1" }, "SysOID":{ "description":"The SNMP system object ID.", "type":"string", "example":"" }, "SysName":{ "description":"The SNMP system name.", "type":"string", "example":"EXAMPLE-ROUTER" }, "SysLocation":{ "description":"The SNMP system location.", "type":"string", "example":"" }, "SysContact":{ "description":"The SNMP system contact.", "type":"string", "example":"" }, "SysDescription":{ "description":"The SNMP system description.", "type":"string", "example":"" }, "SerialNumber":{ "description":"The serial number.", "type":"string", "example":"" } }, "type":"object" }, "deviceDevicesReadForSelect":{ "type":"object", "allOf":[ { "properties":{ "DeviceID":{ "$ref":"#/components/schemas/deviceDevicesRead/properties/DeviceID" }, "DeviceName":{ "$ref":"#/components/schemas/deviceDevicesRead/properties/DeviceName" }, "IPAddress":{ "$ref":"#/components/schemas/deviceDevicesRead/properties/IPv4" }, "IPv6Address":{ "$ref":"#/components/schemas/deviceDevicesRead/properties/IPv6" }, "ParentDeviceID":{ "$ref":"#/components/schemas/deviceDevicesRead/properties/ParentDeviceID" }, "DNSName":{ "$ref":"#/components/schemas/deviceDevicesRead/properties/DNSName" }, "CustomName":{ "$ref":"#/components/schemas/deviceDevicesRead/properties/CustomName" }, "SysName":{ "$ref":"#/components/schemas/deviceDevicesRead/properties/SysName" }, "GeoLocation":{ "$ref":"#/components/schemas/deviceDevicesRead/properties/GeoLocation" } }, "type":"object" } ] }, "deviceCategories":{ "type":"object", "properties":{ "DeviceTypeCategoryName":{ "description":"The device type category name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Appliance" }, "Source":{ "description":"The type of icon. The possible values are Font Awesome Icon, Unified Assurance Icon, and Image.", "type":"string", "example":"Image" }, "ImageName":{ "description":"The image name.", "type":"string", "example":"fugue/drive-network.png" } } }, "deviceCategoriesRead":{ "type":"object", "properties":{ "DeviceTypeCategoryID":{ "description":"The device type category IDs specified for individual CRUD operations.", "type":"integer", "example":"13" }, "DeviceTypeCategoryName":{ "description":"The device type category name.", "type":"string", "example":"Appliance" }, "Source":{ "description":"The type of icon. The possible values are Font Awesome Icon, Unified Assurance Icon, and Image.", "type":"string", "example":"Image" }, "ImageName":{ "description":"The name of the icon, Font Awesome icon, or path to the icon.", "type":"string", "example":"fugue/drive-network.png" } } }, "deviceCategoriesReadForSelect":{ "type":"object", "properties":{ "DeviceTypeCategoryID":{ "description":"The device type category ID.", "type":"integer", "example":"13" }, "DeviceTypeCategoryName":{ "description":"The device type category name.", "type":"string", "example":"Appliance" }, "Source":{ "description":"The type of icon. The possible values are Font Awesome Icon, Unified Assurance Icon, and Image.", "type":"string", "example":"Image" }, "IconPath":{ "description":"The image path for the icon.", "type":"string", "example":"/resources/assure1/images/icons/fugue/drive-network.png" } } }, "deviceGroups":{ "properties":{ "DeviceGroupName":{ "description":"The device group name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Root" }, "ParentDeviceGroupID":{ "description":"The device group ID of the parent group.", "type":"integer", "example":"1" }, "Devices":{ "description":"The list of devices.", "type":"array", "items":{ "type":"object", "properties":{ "DeviceID":{ "type":"integer", "example":"1" }, "DeviceName":{ "type":"string", "example":"router.example.com" } } } }, "Remove":{ "description":"Whether to remove the device from other device groups (1 for true) or not (0 for false).", "type":"boolean", "example":0 } } }, "deviceGroupsRead":{ "properties":{ "DeviceGroupID":{ "description":"The device group ID.", "type":"integer", "example":"1" }, "DisplayName":{ "description":"The display device group name.", "type":"string", "example":"Root" }, "ParentDeviceGroupID":{ "description":"The parent device group's ID.", "type":"integer", "example":"1" }, "cls":{ "description":"The class or type of the device group.", "type":"string", "example":"folder" } }, "type":"object" }, "deviceGroupsReadById":{ "properties":{ "DeviceGroupName":{ "description":"The device group display name.", "type":"string", "example":"Nodes" }, "DeviceGroupID":{ "description":"The device group ID.", "type":"integer", "example":"2" }, "ParentDeviceGroupID":{ "description":"The device group ID of the parent group.", "type":"integer", "example":"1" }, "Devices":{ "description":"The list of devices.", "type":"array", "items":{ "type":"object", "properties":{ "DeviceID":{ "type":"integer", "example":"1" }, "DeviceName":{ "type":"string", "example":"router.example.com" } } } } }, "type":"object" }, "deviceGroupsReadForTree":{ "type":"object", "properties":{ "DeviceGroupID":{ "$ref":"#/components/schemas/deviceGroupsRead/properties/DeviceGroupID" }, "DeviceGroupName":{ "$ref":"#/components/schemas/deviceGroupsReadById/properties/DeviceGroupName" }, "leaf":{ "description":"Whether it is a leaf node (true) or not (false).", "type":"boolean", "example":false } } }, "deviceMetaDataReadForSelect":{ "type":"object", "properties":{ "DeviceMetaTypeID":{ "description":"The device meta type ID.", "type":"integer", "example":"12" }, "MetaData":{ "description":"The metadata for the device.", "type":"string", "example":"Router Collection Server" }, "DeviceMetaTypeName":{ "description":"The device metatype name.", "type":"string", "example":"ADBaseDN" } } }, "deviceMetaTypes":{ "type":"object", "properties":{ "DeviceMetaTypeName":{ "description":"The device metatype name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.\n", "type":"string", "example":"ADBaseDN" }, "RenderTypeID":{ "description":"The ID of property value renderer for the metatag.", "type":"integer", "example":"1" }, "Filterable":{ "description":"Whether a meta type can be used to filter events (1 for true) or not (0 for false).", "type":"integer", "example":"1" } } }, "deviceMetaTypesRead":{ "type":"object", "properties":{ "RenderTypeID":{ "description":"The ID of the property value renderer for the metatag.", "type":"integer", "example":"1" }, "DeviceMetaTypeID":{ "description":"The device metatype ID.", "type":"integer", "example":"12" }, "DeviceMetaTypeName":{ "description":"The device metatype name.", "type":"string", "example":"ADBaseDN" }, "Filterable":{ "description":"Whether a metatype can be used to filter events (1 for true) or not (0 for false).", "type":"integer", "example":"1" }, "FilterableIcon":{ "description":"The icon indicating whether the metatype is filterable. When Filterable is set to 0, this is set to OrbRed.png. When Filterable is set to 1, this is set to OrbGreen.png.", "type":"string", "example":"OrbGreen.png" }, "RenderTypeName":{ "description":"The display name of the property value renderer for the metatag.", "type":"string", "example":"String" }, "DeviceCount":{ "description":"The total number of devices that contain this meta type.", "type":"integer", "example":"1" } } }, "deviceMetaTypesReadForSelect":{ "type":"object", "properties":{ "DeviceMetaTypeID":{ "$ref":"#/components/schemas/deviceMetaTypesRead/properties/DeviceMetaTypeID" }, "DeviceMetaTypeName":{ "$ref":"#/components/schemas/deviceMetaTypesRead/properties/DeviceMetaTypeName" }, "RenderType":{ "description":"The display name of the property value renderer along with all the configuration settings. For example, \"numberBoolean;False;True\".", "type":"string", "example":"String" } } }, "deviceRemote":{ "type":"object", "properties":{ "DeviceID":{ "description":"The device ID to connect to by SSH, VNC or RDP.", "type":"integer" }, "Type":{ "description":"The type of remote session (SSH, VNC or RDP).", "default":"vnc", "type":"string" }, "Port":{ "description":"Uses specific port number (0 - 65535) instead of protocol standard port.", "type":"integer" }, "Token":{ "description":"Uses specific Guacamole token instead of getting from the authenticated session.", "type":"string" }, "Username":{ "description":"The username for logging into remote device.", "type":"string" }, "Password":{ "description":"The password for logging in to the remote device.", "type":"string" } } }, "deviceTypesRead":{ "type":"object", "properties":{ "TypeID":{ "description":"The SysObjectID, prefixed with id-. Used as a device type ID between the UI and API.", "type":"string", "example":"id-1.3.6.1.4.1.3955.1.1" }, "SysObjectID":{ "description":"The SNMP object ID.", "type":"string", "example":"1.3.6.1.4.1.3955.1.1" }, "DeviceTypeName":{ "description":"The device type name.", "type":"string", "example":"ISDN Router" }, "DeviceTypeVendorID":{ "type":"object", "properties":{ "id":{ "description":"The device type vendor ID.", "type":"integer", "example":"79" }, "name":{ "description":"The device type vendor name.", "type":"string", "example":"LinkSys" } } }, "DeviceTypeCategoryID":{ "type":"object", "properties":{ "id":{ "description":"The device type category ID.", "type":"integer", "example":"13" }, "name":{ "description":"The device type category name.", "type":"string", "example":"Appliance" } } }, "DeviceTypeCategoryName":{ "description":"The device type category name.", "type":"string", "example":"Appliance" }, "DeviceTypeVendorName":{ "description":"The device type vendor name.", "type":"string", "example":"LinkSys" } } }, "deviceTypes":{ "type":"object", "properties":{ "SysObjectID":{ "$ref":"#/components/schemas/deviceTypesRead/properties/SysObjectID" }, "DeviceTypeName":{ "description":"The device type name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"ISDNRouter" }, "DeviceTypeVendorID":{ "description":"The device type vendor ID.", "type":"integer", "example":"79" }, "DeviceTypeCategoryID":{ "description":"The device type category ID.", "type":"integer", "example":"13" } } }, "deviceTypesReadForSelect":{ "type":"object", "properties":{ "SysObjectID":{ "$ref":"#/components/schemas/deviceTypesRead/properties/SysObjectID" }, "DeviceTypeName":{ "$ref":"#/components/schemas/deviceTypesRead/properties/DeviceTypeName" }, "Vendor":{ "$ref":"#/components/schemas/deviceTypesRead/properties/DeviceTypeVendorName" }, "VendorDevice":{ "description":"The vendor, concatenated with DeviceTypeName.", "type":"string", "example":"Vendor Router" } } }, "deviceVendors":{ "type":"object", "properties":{ "DeviceTypeVendorName":{ "description":"The device type vendor name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"24+2G" } } }, "deviceVendorsRead":{ "type":"object", "properties":{ "DeviceTypeVendorID":{ "description":"The device type vendor ID.", "type":"integer", "example":"1" }, "DeviceTypeVendorName":{ "description":"The device type vendor name.", "type":"string", "example":"24+2G" } } }, "deviceDeviceViews":{ "type":"object", "properties":{ "PropertyName":{ "description":"The property name.", "type":"string", "example":"DeviceName" }, "PropertyValue":{ "description":"The property value.", "type":"string", "example":"router.example" } } }, "deviceDeviceViewsFull":{ "type":"object", "properties":{ "PropertyName":{ "description":"The property name.", "type":"string", "example":"DeviceName" }, "PropertyValue":{ "description":"The property value.", "type":"string", "example":"router.example" } } }, "deviceWindowsRead":{ "type":"object", "properties":{ "WindowID":{ "description":"The device maintenance window ID.", "type":"integer", "example":"2" }, "WindowName":{ "description":"The device maintenance window name.", "type":"string", "example":"device-nav" }, "WindowDescr":{ "description":"The device maintenance window description.", "type":"string", "example":"Maintenance window 2" }, "StartTime":{ "description":"The maintenance window start time in YYYY-MM-DD HH:MM:SS format, converted from epoch time.", "type":"string", "example":"2023-08-07 05:00:00" }, "StopTime":{ "description":"The maintenance window stop time in YYYY-MM-DD HH:MM:SS format, converted from epoch time.", "type":"string", "example":"2023-08-14 05:00:00" }, "DeviceCount":{ "description":"The number of devices with the assigned WindowID.", "type":"integer", "example":"2" }, "Devices":{ "description":"The array of maintenance window devices.", "type":"array", "items":{ "type":"object", "properties":{ "DeviceID":{ "description":"The device ID.", "type":"integer" }, "DeviceName":{ "description":"The device name.", "type":"string" }, "DeviceZoneID":{ "description":"The device zone ID.", "type":"integer" } } }, "example":[ { "DeviceID":"2", "DeviceName":"router1.example", "DeviceZoneID":"1" }, { "DeviceID":"4", "DeviceName":"router2.example", "DeviceZoneID":"1" } ] } } }, "deviceWindows":{ "type":"object", "properties":{ "WindowName":{ "description":"The device maintenance window name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"device-nav" }, "StartTime":{ "description":"The maintenance window start time in epoch time.", "type":"string", "example":1691364600 }, "StopTime":{ "description":"The maintenance window stop time in epoch time.", "type":"string", "example":1691969400 }, "Devices":{ "$ref":"#/components/schemas/deviceWindowsRead/properties/Devices" }, "WindowDescr":{ "$ref":"#/components/schemas/deviceWindowsRead/properties/WindowDescr" } } }, "deviceWindowsReadForSelect":{ "type":"object", "properties":{ "WindowID":{ "$ref":"#/components/schemas/deviceWindowsRead/properties/WindowID" }, "WindowName":{ "$ref":"#/components/schemas/deviceWindowsRead/properties/WindowName" } } }, "deviceZonesRead":{ "type":"object", "properties":{ "DeviceZoneID":{ "description":"The device zone ID.", "type":"integer", "example":"1" }, "DeviceZoneName":{ "description":"The device zone name.", "type":"string", "example":"Default First Zone" }, "DeviceCount":{ "description":"The number of devices.", "type":"integer", "example":"1" } } }, "deviceZonesReadForSelect":{ "type":"object", "properties":{ "DeviceZoneID":{ "$ref":"#/components/schemas/deviceZonesRead/properties/DeviceZoneID" }, "DeviceZoneName":{ "$ref":"#/components/schemas/deviceZonesRead/properties/DeviceZoneName" } } }, "deviceNavigationDevicesRead":{ "properties":{ "DeviceID":{ "description":"The device ID.", "type":"integer", "example":"40" }, "DeviceName":{ "description":"The device name.", "type":"string", "example":"router.example.com" }, "ParentDeviceID":{ "description":"The deviceID of parent for virtual devices.", "type":"integer", "example":"0" }, "IPAddress":{ "description":"The IPv4 address.", "type":"string", "example":"100.77.220.52" }, "IPv6Address":{ "description":"The IPv6 Address, in hex notation.", "type":"string", "example":"2001:DB8::1" }, "DeviceZoneID":{ "description":"The device zone ID for individual CRUD operations.", "type":"integer", "example":"1" }, "DeviceZoneName":{ "description":"The device zone name.", "type":"string", "example":"Default First Zone" }, "DNSName":{ "description":"The DNS name.", "type":"string", "example":"router1.example.com" }, "DeviceTypeCategoryName":{ "description":"The device type category name.", "type":"string", "example":"Appliance" }, "DeviceTypeVendorName":{ "description":"The vendor name.", "type":"string", "example":"24+2G" }, "DeviceTypeName":{ "description":"The device type name.", "type":"string", "example":"Router" }, "DeviceNameEncoded":{ "description":"The encoded device name.", "type":"string", "example":"router.example.com" }, "DeviceConditions":{ "description":"The device conditions.", "type":"string", "example":null, "nullable":true }, "ConditionsTooltip":{ "description":"The conditions tooltip.", "type":"string", "example":"" }, "icon":{ "description":"The icon image.", "type":"string", "example":"fa fa-question-white" }, "iconCls":{ "description":"The CSS class for icons.", "type":"string", "example":"empty" }, "leaf":{ "description":"The leaf node of the tree.", "type":"boolean", "example":true }, "viewTitle":{ "description":"Title", "type":"string", "example":"Device Overview: router.example.com" }, "LoadingStates":{ "description":"The loading states.", "type":"boolean", "example":true }, "GeoLocation":{ "description":"The GeoJSON Point of the device's longitude and latitude).", "type":"string", "example":"{\"type\": \"Point\", \"coordinates\": [0.0, 0.0]}" }, "CustomName":{ "description":"The custom name.", "type":"string", "example":"Custom Nice Name" }, "SysName":{ "description":"The SNMP system name.", "type":"string", "example":"EXAMPLE-ROUTER" } }, "type":"object" }, "deviceNavigationDevicesReadForSelect":{ "properties":{ "DeviceID":{ "description":"The device ID.", "type":"integer", "example":"40" }, "DeviceName":{ "description":"The device name.", "type":"string", "example":"router.example.com" }, "DeviceNameHighlight":{ "description":"The device name highlight.", "type":"string", "example":"" }, "icon":{ "description":"The icon image.", "type":"string", "example":"fa fa-question-white" }, "iconQtip":{ "description":"The icon Qtip.", "type":"string", "example":"Device" }, "leaf":{ "description":"The leaf node of the tree.", "type":"boolean", "example":true }, "viewTitle":{ "description":"The title.", "type":"string", "example":"Device Overview: router.example.com" }, "AvailabilityExists":{ "description":"Whether availability exists (true) or not (false).", "type":"boolean", "example":true }, "AvailabilitySeverity":{ "description":"The availability severity.", "type":"string", "example":"normal" }, "AvailabilityText":{ "description":"The availability text.", "type":"string", "example":"Availability (last hour) : 100%" }, "ThresholdExists":{ "description":"Whether a threshold exists (true) or not (false).", "type":"boolean", "example":true }, "ThresholdSeverity":{ "description":"The threshold severity.", "type":"string", "example":null, "nullable":true }, "ThresholdText":{ "description":"The threshold text.", "type":"string", "example":null, "nullable":true }, "EventExists":{ "description":"Whether an event exists (true) or not (false).", "type":"boolean", "example":true }, "EventSeverity":{ "description":"The event severity.", "type":"string", "example":null, "nullable":true }, "EventText":{ "description":"The event text.", "type":"string", "example":null, "nullable":true }, "CustomName":{ "description":"The custom name.", "type":"string", "example":"Custom Nice Name" }, "DNSName":{ "description":"The DNS name.", "type":"string", "example":"router.example.com" }, "SysName":{ "description":"The SNMP system name.", "type":"string", "example":"EXAMPLE-ROUTER" }, "IPAddress":{ "description":"The IPv4 address.", "type":"string", "example":"100.77.220.52" }, "IPv6Address":{ "description":"The IPv6 address, in hex notation.", "type":"string", "example":"2001:DB8::1" }, "DeviceTypeCategoryName":{ "description":"The device type category name.", "type":"string", "example":"Appliance" }, "DeviceTypeVendorName":{ "description":"The device type vendor name.", "type":"string", "example":"LinkSys" }, "DeviceTypeName":{ "description":"The device type name.", "type":"string", "example":"(any Cable/DSL Router?)" }, "DeviceMetaTag":{ "description":"The device meta tag.", "type":"string", "example":"" } }, "type":"object" }, "deviceNavigationDevicesReadDeviceVertex":{ "properties":{ "VertexID":{ "description":"The vertex ID.", "type":"string", "example":"037e3b2c-db9a-450b-b715-5287cf4c4c14" }, "VertexName":{ "description":"The vertex name.", "type":"string", "example":"router.example.com" } }, "type":"object" }, "deviceNavigationDevicesReadStates":{ "properties":{ "DeviceID":{ "description":"The device ID.", "type":"integer", "example":"40" }, "DeviceName":{ "description":"The device name.", "type":"string", "example":"router.example.com" }, "AvailabilityExists":{ "description":"Whether availability exists (true) or not (false).", "type":"boolean", "example":true }, "AvailabilitySeverity":{ "description":"The availability severity.", "type":"string", "example":"normal" }, "AvailabilityText":{ "description":"The availability text.", "type":"string", "example":"Availability (last hour) : 100%" }, "ThresholdExists":{ "description":"Whether a threshold exists (true) or not (false).", "type":"boolean", "example":true }, "ThresholdSeverity":{ "description":"The threshold severity.", "type":"string", "example":null, "nullable":true }, "ThresholdText":{ "description":"The threshold text.", "type":"string", "example":null, "nullable":true }, "EventExists":{ "description":"Whether an event exists (true) or not (false).", "type":"boolean", "example":true }, "EventSeverity":{ "description":"The event severity.", "type":"string", "example":null, "nullable":true }, "EventText":{ "description":"The event text.", "type":"string", "example":null, "nullable":true }, "LoadingStates":{ "description":"Whether states are loading (true) or not (false).", "type":"boolean", "example":false } }, "type":"object" }, "deviceNavigationDevicesReadStatesNetworks":{ "properties":{ "DeviceID":{ "description":"The device ID.", "type":"integer", "example":"40" }, "NetworkDetails":{ "description":"Networking information that has been gathered for the device. nodata means nothing has been gathered.", "type":"string", "example":"Some Data" }, "NetworkDetailsData":{ "description":"Summary accounting information of networking interfaces that includes interfaces, IP routes, ARP, MAC addresses, VLANS, and CDP neighbors.", "type":"array", "items":{ }, "example":[ "Data Details" ] }, "LoadingStates":{ "description":"Whether states are loading (true) or not (false).", "type":"boolean", "example":false } }, "type":"object" }, "deviceNavigationDevicesReadStatesAvailability":{ "properties":{ "DeviceID":{ "description":"The device ID.", "type":"integer", "example":"40" }, "AvailabilityExists":{ "description":"Whether availability exists (true) or not (false).", "type":"boolean", "example":true }, "AvailabilitySeverity":{ "description":"The average availability status values. \n\nThe possible values are: \n", "type":"string", "example":"normal" }, "Availability":{ "description":"The average availability value ranges between 0 and 100.", "type":"number", "example":"100.00" }, "LoadingStates":{ "description":"Whether states are loading (true) or not (false).", "type":"boolean", "example":false } }, "type":"object" }, "deviceNavigationDevicesReadStatesEvent":{ "properties":{ "DeviceID":{ "description":"The device ID.", "type":"integer", "example":"40" }, "EventExists":{ "description":"Whether an event exists (true) or not (false).", "type":"boolean", "example":true }, "EventSeverity":{ "description":"The highest event severity for the device. Possible values are info, critical, major, minor, normal,and unknown.", "type":"string", "example":"normal" }, "Count":{ "description":"The total number of unique events reported for the device.", "type":"integer", "example":0 }, "SumCount":{ "description":"The SUM(Count) of all the unique events. For example, if a device has 2 events, the first with a count of 1 and the second with a count of 9, then the Count is 2, SumCount is 10.", "type":"integer", "example":0 }, "SeverityValues":{ "description":"An array of event counts for each severity value in the following order - Normal, Unknown, Info, Minor, Major, and Critical.", "type":"array", "items":{ }, "example":[ 0, 0, 0, 0, 0, 0 ] }, "LoadingStates":{ "description":"Whether states are loading (true) or not (false).", "type":"boolean", "example":false } }, "type":"object" }, "deviceNavigationDevicesReadStatesThresholds":{ "properties":{ "DeviceID":{ "description":"The device ID.", "type":"integer", "example":"40" }, "ThresholdExists":{ "description":"Whether a threshold exists or (true) or not (false).", "type":"boolean", "example":true }, "ThresholdSeverity":{ "description":"The highest severity status of violated metric thresholds. Possible values are critical, minor, normal, and not configured.", "type":"string", "example":"normal" }, "ThresholdData":{ "description":"The summary accounting information of violated thresholds status.", "type":"array", "items":{ }, "example":[ "Metric Thresholds", "Normal", 2 ] }, "LoadingStates":{ "description":"Whether states are loading (true) or not (false).", "type":"boolean", "example":false } }, "type":"object" }, "diagramDiagramsRead":{ "type":"object", "properties":{ "DiagramTypeID":{ "description":"The diagram type ID. Can be basic (1) or dynamic device (2).", "type":"integer", "example":"1", "enum":[ 1, 2 ] }, "DiagramID":{ "description":"The diagram ID.", "type":"integer", "example":"4" }, "DiagramName":{ "description":"The name of the diagram.", "type":"string", "example":"New Diagram" }, "Width":{ "description":"The width of the diagram.", "type":"integer", "example":"600" }, "Height":{ "description":"The height of the diagram.", "type":"integer", "example":"400" }, "AutoFit":{ "description":"Whether the diagram display should automatically fit into the panel (true) or not (false), disregarding the size configuration.", "type":"boolean", "example":"0" }, "DiagramTypeName":{ "description":"The name of the diagram type.", "type":"string", "example":"Basic", "enum":[ "Basic", "Dynamic Devices" ] }, "DiagramGroupID":{ "description":"The initial diagram group.", "type":"string", "example":"1" }, "DiagramGroupName":{ "description":"The name of the diagram group.", "type":"string", "example":"Root" }, "Revision":{ "description":"The latest revision number.", "type":"string", "example":"3" }, "TimestampModified":{ "description":"The timestamp of last modification.", "type":"string", "example":"2023-08-09 05:47:46" } } }, "diagramDiagrams":{ "type":"object", "properties":{ "DiagramName":{ "description":"The diagram name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"New Diagram" }, "DiagramTypeID":{ "$ref":"#/components/schemas/diagramDiagramsRead/properties/DiagramTypeID" }, "Width":{ "$ref":"#/components/schemas/diagramDiagramsRead/properties/Width" }, "Height":{ "$ref":"#/components/schemas/diagramDiagramsRead/properties/Height" }, "AutoFit":{ "description":"Whether the diagram display should automatically fit into the panel (true) or not (false), disregarding the size configuration.", "type":"boolean", "example":false }, "DiagramGroupID":{ "description":"The initial diagram group.", "type":"string", "example":1 }, "SVG":{ "description":"The diagram SVG (actual layout definition).", "type":"string", "example":"\n\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\n\t\n\t\n\t\n\t\t\n\t\t\n\t\n\t\n\t\n\t\t\n\t\n\t\t\n\t\n\t\t\n\t\n" }, "Message":{ "description":"The revision commit message.", "type":"string", "example":"Changing the shape" } } }, "diagramDiagramsReadForSelect":{ "type":"object", "properties":{ "DiagramID":{ "description":"The unique diagram ID.", "type":"integer", "example":"4" }, "DiagramName":{ "description":"The diagram name.", "type":"string", "example":"New Diagram" } } }, "diagramDiagramsReadRevisionsForSelect":{ "type":"object", "properties":{ "RevisionID":{ "description":"The revision ID.", "type":"integer", "example":"5" }, "RevisionName":{ "description":"The revision name.", "type":"string", "example":"r5 [2023-10-05 15:58:01 [admin] " } } }, "diagramDiagramGroupsRead":{ "type":"object", "properties":{ "DiagramGroupID":{ "description":"The diagram group ID.", "type":"integer", "example":"1" }, "DisplayName":{ "description":"The display name.", "type":"string", "example":"Root" }, "cls":{ "type":"string", "example":"folder" } } }, "diagramDiagramGroupReadByID":{ "type":"object", "properties":{ "DiagramGroupName":{ "description":"The diagram group name.", "type":"string", "example":"Test Group" }, "DiagramGroupID":{ "description":"The diagram group ID for individual CRUD operations.", "type":"integer", "example":"3" }, "ParentDiagramGroupID":{ "description":"The parent diagram group ID.", "type":"integer", "example":"1" }, "Diagrams":{ "description":"The list of diagrams IDs associated with the diagram group.", "type":"array", "items":{ "type":"object", "properties":{ "DiagramID":{ "description":"The diagram ID.", "type":"integer", "example":"897" }, "DiagramName":{ "description":"The diagram name.", "type":"string", "example":"2672 -- try 2" } } }, "example":[ { "DiagramID":"897", "DiagramName":"2672 -- try 2" }, { "DiagramID":"911", "DiagramName":"basic widgets with an on click link to oracle.com" } ] } } }, "diagramDiagramGroups":{ "type":"object", "properties":{ "DiagramGroupName":{ "description":"The diagram group name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Test Group" }, "ParentDiagramGroupID":{ "description":"The parent diagram group ID.", "type":"integer", "example":"1" }, "Diagrams":{ "description":"The list of diagrams IDs associated with the diagram group.", "type":"array", "items":{ "type":"integer" }, "example":[ 897, 911 ] }, "Remove":{ "description":"Whether to remove the diagram from other diagram groups (1) or not (2). A diagram can belong to multiple groups, but setting this to 1 makes the diagram appear only in the specified group.", "type":"boolean", "example":0 } } }, "diagramDiagramGroupsUpdate":{ "type":"object", "properties":{ "DiagramGroupName":{ "description":"Diagram group name if specified, applies the new name to the diagram group.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Test Group" }, "ParentDiagramGroupID":{ "description":"The diagram group ID of the parent group. If specified, it the diagram group will be moved under the diagram group specified in ParentDiagramGroupID.", "type":"integer", "example":"1" }, "Diagrams":{ "description":"The list of diagram IDs associated with the diagram group.", "type":"array", "items":{ "type":"integer" }, "example":[ 897, 911 ] }, "Remove":{ "description":"Whether to remove the diagram from other diagram groups (1) or not (2). A diagram can belong to multiple groups, but setting this to 1 makes the diagram appear only in the specified group.", "type":"boolean", "example":0 } } }, "diagramDiagramGroupsReadForTree":{ "type":"object", "properties":{ "DiagramGroupID":{ "$ref":"#/components/schemas/diagramDiagramGroupReadByID/properties/DiagramGroupID" }, "DiagramGroupName":{ "$ref":"#/components/schemas/diagramDiagramGroupReadByID/properties/DiagramGroupName" }, "leaf":{ "description":"Whether it is a leaf node (true) or not (false).", "type":"boolean", "example":false }, "iconCls":{ "description":"The CSS class for icons.", "type":"string", "example":"x-tree-icon-parent" } } }, "diagramMenusRead":{ "type":"object", "properties":{ "MenuID":{ "description":"The menu ID.", "type":"integer", "example":"2" }, "DisplayName":{ "description":"The menu display name.", "type":"string", "example":"Device Info" }, "ParentMenuID":{ "description":"The parent menu ID.", "type":"integer", "example":"1" }, "cls":{ "description":"The CSS class icon for the tree item.", "type":"string", "example":"folder" } } }, "diagramMenusReadByID":{ "type":"object", "properties":{ "MenuName":{ "description":"The menu name.", "type":"string", "example":"Device Info" }, "UserGroupID":{ "description":"The user group ID.", "type":"object", "properties":{ "id":{ "example":"1" }, "name":{ "example":"Administrators" } } }, "ParentMenuID":{ "description":"The parent menu ID.", "type":"integer", "example":"1" }, "Tools":{ "description":"The list of tool IDs.", "type":"object", "properties":{ "ToolID":{ "description":"The tool ID.", "type":"integer", "example":"2" }, "ToolName":{ "description":"The tool name.", "type":"string", "example":"Device Health" } }, "example":[ { "ToolID":"2", "ToolName":"Device Health" }, { "ToolID":"1", "ToolName":"Manage Device" }, { "ToolID":"3", "ToolName":"Network Details" } ] } } }, "diagramMenu":{ "type":"object", "properties":{ "MenuName":{ "description":"The name of the menu to create.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Device Info" }, "ParentMenuID":{ "description":"The parent menu ID.", "type":"integer", "example":"1" }, "Tools":{ "description":"The list of tool IDs. If specified, this set of menu tools is associated with the menu.", "type":"array", "items":{ "type":"integer" }, "example":[ 2, 1, 3 ] } } }, "diagramMenuUpdate":{ "type":"object", "properties":{ "MenuName":{ "description":"The new name of the menu. If specified, the name of the menu is updated with this new value.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Device Info" }, "ParentMenuID":{ "description":"The parent menu ID. If specified, the menu is moved to this parent menu.", "type":"integer", "example":"1" }, "Tools":{ "description":"The list of tool IDs. If specified, this set of menu tools is associated with the menu.", "type":"array", "items":{ "type":"integer" }, "example":[ 2, 1, 3 ] } } }, "diagramMenusReadForSelect":{ "type":"object", "properties":{ "MenuID":{ "$ref":"#/components/schemas/diagramMenusRead/properties/MenuID" }, "MenuName":{ "$ref":"#/components/schemas/diagramMenusReadByID/properties/MenuName" } } }, "diagramMenusReadForMenu":{ "type":"object", "properties":{ "MenuID":{ "$ref":"#/components/schemas/diagramMenusRead/properties/MenuID" }, "text":{ "description":"The display name of the diagram menu.", "example":"Device Info" }, "MenuName":{ "$ref":"#/components/schemas/diagramMenusReadByID/properties/MenuName" }, "ParentMenuID":{ "$ref":"#/components/schemas/diagramMenusReadByID/properties/ParentMenuID" }, "menu":{ "description":"The list of menu items.", "type":"array", "items":{ "type":"object", "properties":{ "ToolID":{ "description":"The tool ID.", "type":"integer", "example":"2" }, "text":{ "description":"The display name of the menu tool.", "type":"string", "example":"Device Health" }, "ToolName":{ "description":"The display name of the menu tool.", "type":"string", "example":"Device Health" }, "ToolTypeName":{ "description":"The tool type name.", "type":"string", "example":"View", "enum":[ "View", "SQL" ] }, "Icon":{ "description":"The path for the icon image file.", "type":"string", "example":"fugue/heart--exclamation.png" }, "ToolPath":{ "description":"The relative path to a view tool.", "type":"string", "example":"dashboard/Device%20Overview?DeviceName=&FilterType=DeviceName&FilterValue=&DeviceZoneName=" }, "ToolPathTypeName":{ "description":"The type of tool path.\nAllowed Values:\n
  • 1: Local
    • \n
  • 2: Internal
    • \n
  • 3: Hybrid
    • \n
  • 4: Remote
", "type":"string", "example":"Internal" }, "ToolTarget":{ "description":"The tool target.\nAllowed Values:\n
  • window
    • \n
  • currenttab
    • \n
  • newtab
", "type":"string", "example":"window" }, "Width":{ "description":"The menu tool width.", "type":"integer", "example":"80" }, "Height":{ "description":"The menu tool height.", "type":"integer", "example":"80" } } }, "example":[ { "ToolID":"1", "text":"Manage Device", "ToolName":"Manage Device", "ToolTypeName":"View", "icon":"/resources/assure1/images/icons/silk/brick_go.png", "ToolPath":"device/devices?filter=[{\"property\":\"DeviceName\",\"value\":\"\",\"type\":\"string\",\"operator\":\"like\"}]", "ToolPathTypeName":"Internal", "ToolTarget":"window", "Width":"500", "Height":"700" }, { "ToolID":"2", "text":"Device Health", "ToolName":"Device Health", "ToolTypeName":"View", "icon":"/resources/assure1/images/icons/fugue/heart--exclamation.png", "ToolPath":"dashboard/Device%20Overview?DeviceName=&FilterType=DeviceName&FilterValue=&DeviceZoneName=", "ToolPathTypeName":"Internal", "ToolTarget":"window", "Width":"80", "Height":"80" }, { "ToolID":"3", "text":"Network Details", "ToolName":"Network Details", "ToolTypeName":"View", "icon":"/resources/assure1/images/icons/fugue/network-clouds.png", "ToolPath":"dashboard/Network%20Details?DeviceName=&StartVertexName=&GraphType=VertexList&GroupByVertexTypeName=No%20Grouping&VertexTuckAwayTypeName=Interface", "ToolPathTypeName":"Internal", "ToolTarget":"window", "Width":"80", "Height":"80" } ] } } }, "diagramToolsRead":{ "type":"object", "properties":{ "ToolID":{ "description":"The unique tool ID.", "type":"integer", "example":"2" }, "ToolName":{ "description":"The tool name.", "type":"string", "example":"Device Health" }, "ToolTypeID":{ "description":"The tool type ID.\nAllowed Values:\n
  • 1: View. The menu tool executes in the URL path.
    • \n
  • 2: SQL. The menu tool executes in SQL statements.
", "type":"integer", "example":"1" }, "ToolTypeName":{ "description":"The tool type name associated with the specified ToolTypeID.", "type":"string", "example":"View" }, "Icon":{ "description":"The relative image path for the icon.", "type":"string", "example":"fugue/heart--exclamation.png" }, "ToolPath":{ "description":"The URL path for a View tool.", "type":"string", "example":"dashboard/Device%20Overview?DeviceName=&FilterType=DeviceName&FilterValue=&DeviceZoneName=" }, "ToolPathType":{ "description":"How the View tool runs with the associated diagram widget. Allowed values:\n
  • Local
    • \n
  • Internal
    • \n
  • Hybrid
    • \n
  • Remote
", "type":"string", "example":"Internal" }, "ToolPathTypeID":{ "description":"The ID associated with the ToolPathType for View tools. \nAllowed Values:\n
  • 1: Local
    • \n
  • 2: Internal
    • \n
  • 3: Hybrid
    • \n
  • 4: Remote
", "type":"integer", "example":"2" }, "ToolTarget":{ "description":"Where to open the View tool.", "type":"string", "enum":[ "window", "currenttab", "newtab" ], "example":"window" }, "Width":{ "description":"The width of the View tool when ToolTarget is set to window.", "type":"integer", "example":"80" }, "Height":{ "description":"The height of the View tool when ToolTarget is set to window.", "type":"integer", "example":"80" } } }, "diagramTools":{ "type":"object", "properties":{ "ToolName":{ "description":"The diagram tool name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Device Health" }, "ToolPath":{ "$ref":"#/components/schemas/diagramToolsRead/properties/ToolPath" }, "ToolPathTypeID":{ "$ref":"#/components/schemas/diagramToolsRead/properties/ToolPathTypeID" }, "ToolTarget":{ "$ref":"#/components/schemas/diagramToolsRead/properties/ToolTarget" }, "Width":{ "$ref":"#/components/schemas/diagramToolsRead/properties/Width" }, "Height":{ "$ref":"#/components/schemas/diagramToolsRead/properties/Height" }, "Icon":{ "$ref":"#/components/schemas/diagramToolsRead/properties/Icon" } } }, "diagramToolsReadForSelect":{ "type":"object", "properties":{ "ToolID":{ "$ref":"#/components/schemas/diagramToolsRead/properties/ToolID" }, "ToolName":{ "$ref":"#/components/schemas/diagramToolsRead/properties/ToolName" } }, "example":[ { "ToolID":0, "ToolName":"-- Separator --" }, { "ToolID":"2", "ToolName":"Device Health" }, { "ToolID":"5", "ToolName":"Events" }, { "ToolID":"1", "ToolName":"Manage Device" }, { "ToolID":"4", "ToolName":"Metrics" }, { "ToolID":"3", "ToolName":"Network Details" } ] }, "diagramTypesReadForSelect":{ "type":"object", "properties":{ "DiagramTypeID":{ "description":"The diagram type ID. \nAllowed values:\n
  • 1: Basic
    • \n
  • 2: Dynamic Devices
", "type":"integer", "example":"1" }, "DiagramTypeName":{ "description":"The diagram type name.", "type":"string", "enum":[ "Basic", "Dynamic Device" ], "example":"Basic" } } }, "diagramWidgetsRead":{ "type":"object", "properties":{ "DiagramWidgetID":{ "description":"The diagram widget ID.", "type":"integer", "example":"1" }, "DiagramWidgetName":{ "description":"The diagram widget name.", "type":"string", "example":"Line" }, "ImagePath":{ "description":"The image filepath.", "type":"string", "example":"/resources/assure1/images/widgets/WidgetBasicLine.png" }, "DiagramWidgetTypeName":{ "description":"The diagram widget type name.", "type":"string", "example":"Basic" } } }, "diagramNavigationReadForTree":{ "type":"object", "properties":{ "text":{ "description":"The text associated with the diagram.", "type":"string", "example":"New Diagram" }, "leaf":{ "description":"Whether it is a leaf node (true) or not (false).", "type":"boolean", "example":true }, "iconCls":{ "description":"The CSS class for icons.", "type":"string", "example":"fa fa-object-group" }, "DiagramID":{ "description":"The diagram ID.", "type":"integer", "example":"4" }, "DiagramName":{ "description":"The diagram name.", "type":"string", "example":"New Diagram" }, "Width":{ "description":"The diagram width.", "type":"integer", "example":"600" }, "Height":{ "description":"The diagram height.", "type":"integer", "example":"400" } } }, "discoveryDiscoverReadDiscoveryJobs":{ "type":"object", "properties":{ "ServerID":{ "description":"The server ID.", "type":"integer", "example":"9" }, "ServerName":{ "description":"The server name.", "type":"string", "example":"server1.example.com" }, "Jobs":{ "description":"The list of jobs.", "type":"array", "items":{ "type":"object", "properties":{ "JobID":{ "description":"The job ID.", "type":"integer" }, "JobName":{ "description":"The job name.", "type":"string" } } }, "example":[ { "JobID":"35", "JobName":"Device Auto Discovery" }, { "JobID":"133", "JobName":"Device Auto Discovery - Dev Playgrounds and QA" } ] } } }, "discoveryDiscoverReadDiscoveryJobServers":{ "type":"object", "properties":{ "ServerID":{ "description":"The server ID.", "type":"integer", "example":"9" }, "ServerName":{ "description":"The server name.", "type":"string", "example":"server1.example.com" } } }, "discoveryDiscoverReadDiscoveryJobJobs":{ "type":"object", "properties":{ "JobID":{ "description":"The job ID.", "type":"integer", "example":"35" }, "JobName":{ "description":"The job name.", "type":"string", "example":"Device Auto Discovery" } } }, "discoveryExcludesRead":{ "type":"object", "properties":{ "ProfileStatusID":{ "description":"The profile status ID. Either 0 (disabled) or 1 (enabled).", "type":"integer", "example":"0" }, "ProfileStatus":{ "description":"The profile status.", "type":"string", "example":"Disabled" }, "DeviceZoneID":{ "description":"The device zone name and ID.", "type":"object", "properties":{ "id":{ "description":"The device zone ID.", "type":"integer", "example":"1" }, "name":{ "description":"The device zone name associated with the specified id.", "type":"string", "example":"Default First Zone" } } }, "Seeds":{ "description":"The seeds excluded from discovery.", "type":"string", "example":"192.168.100.255,10.10.10.255", "nullable":true }, "IPRange":{ "description":"The IP range excluded from discovery. For example, 10.*.0-9.1,2,3,4.", "type":"string", "example":"0.0.0-1.*", "nullable":true }, "ProfileID":{ "description":"The discovery profile ID for individual CRUD operations.", "type":"integer", "example":"2" }, "ProfileName":{ "description":"The discovery profile name.", "type":"string", "example":"Example Device List" }, "ProfileDescr":{ "description":"The discovery profile description, which explains why the devices are being excluded.", "type":"string", "example":"This is an example of excluding a list of devices from discovery." }, "ProfileStatusIcon":{ "description":"The profile status icon.", "type":"string", "example":"OrbRed.png" }, "ProfileType":{ "description":"The profile type.\nAllowed Values:\n
  • 1: IP Range
    • \n
  • 2: Device List
", "type":"string", "example":"Device List" }, "DeviceZoneName":{ "description":"The device zone name.", "type":"string", "example":"Default First Zone" } } }, "discoveryExcludes":{ "type":"object", "properties":{ "ProfileName":{ "description":"The exclusion profile name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Example Device list" }, "ProfileDescr":{ "$ref":"#/components/schemas/discoveryExcludesRead/properties/ProfileDescr" }, "DeviceZoneID":{ "description":"The device zone ID.", "type":"integer", "example":"1" }, "ProfileStatusID":{ "$ref":"#/components/schemas/discoveryExcludesRead/properties/ProfileStatusID" }, "ProfileTypeID":{ "description":"The profile type ID.\nAllowed Values:\n
  • 1: IP Range
    • \n
  • 2: Device List
", "type":"integer", "example":1 }, "IPRange":{ "description":"Required when the value of ProfileTypeID is 1. The IP range to exclude from discovery. For example, 10.*.0-9.1,2,3,4.", "type":"string", "example":"0.0.0-1.*", "nullable":true }, "Seeds":{ "description":"Required when the value of ProfileTypeID is 2. The seeds to exclude from discovery. For example, 10.10.10.1,hostname,172.16.10.1.", "type":"string", "example":"192.168.100.255,10.10.10.255", "nullable":true } } }, "discoveryExcludesReadForSelect":{ "type":"object", "properties":{ "ProfileID":{ "$ref":"#/components/schemas/discoveryExcludesRead/properties/ProfileID" }, "ProfileName":{ "$ref":"#/components/schemas/discoveryExcludesRead/properties/ProfileName" } } }, "discoveryIncludesRead":{ "type":"object", "properties":{ "ProfileTypeID":{ "description":"The profile type ID.\nAllowed Values:\n
  • 1: Ping Scan
    • \n
  • 2: Seed Scan
    • \n
  • 3: LDAP Scan
    • \n
  • 4: CDP Scan
", "type":"integer", "example":"3" }, "DeviceZoneID":{ "description":"The device zone name and ID.", "type":"object", "properties":{ "id":{ "description":"The device zone ID.", "type":"integer", "example":"1" }, "name":{ "description":"The device zone name associated with the specified id.", "type":"string", "example":"Default First Zone" } } }, "CDPSeeds":{ "description":"The CDP seeds. For example, 10.10.10.1,hostname,172.16.10.1.", "type":"string", "nullable":true, "example":null }, "Seeds":{ "description":"The seeds. For example, 10.10.10.1,hostname,172.16.10.1.", "type":"string", "example":null }, "Hops":{ "description":"The number of iterations for CDP discovery.", "type":"integer", "nullable":true, "example":null }, "ServerName":{ "description":"The LDAP server FQDN host or IP address.", "type":"string", "example":"ldap.localdomain.local" }, "ServerPort":{ "description":"The LDAP server port (TCP only).", "type":"integer", "example":389 }, "BaseDN":{ "description":"The LDAP base domain name.", "type":"string", "example":"DC=localdomain,DC=local" }, "UserDN":{ "description":"The LDAP base user name.", "type":"string", "example":"monolith@localhost" }, "UserPass":{ "description":"The LDAP base user password.", "type":"string", "example":"password" }, "Query":{ "description":"The LDAP query text to produce server names.", "type":"string", "example":"(objectClass=computer)" }, "IPRange":{ "description":"The IP Range (for example, 10.*.0-9.1,2,3,4 for glob expansion; 172.16.10.0/24 for CIDR expansion).", "type":"string", "example":"10.*.0-9.1" }, "CIDR":{ "description":"The type of range expansion.\nAllowed Values:\n
  • 1: Glob expansion
    • \n
  • 2: CIDR expansion
", "type":"string", "example":null }, "CIDRFlag":{ "description":"Whether to use CIDR (Enabled) or not (Disabled).", "type":"string", "nullable":true, "example":null }, "ProfileID":{ "description":"The discovery profile ID for individual CRUD operations.", "type":"integer", "example":"3" }, "ProfileName":{ "description":"The discovery profile name.", "type":"string", "example":"Example Active Directory Scan" }, "ProfileStatusID":{ "description":"The profile status ID. Either 0 (disabled) or 1 (enabled).", "type":"integer", "example":"0" }, "ProfileStatusIcon":{ "description":"The profile status icon.", "type":"string", "example":"OrbRed.png" }, "ProfileStatus":{ "description":"The profile status. The allowed values are:\n
  • Enabled
    • \n
  • Disabled
", "example":"Disabled" }, "ProfileType":{ "description":"The profile type.\nAllowed Values:\n
  • Ping Scan
    • \n
  • Seed Scan>
    • \n
  • LDAP Scan
    • \n
  • CDP Scan
", "type":"string", "example":"LDAP Scan" }, "DeviceZoneName":{ "description":"The device zone name.", "type":"string", "example":"Default First Zone" } } }, "discoveryIncludes":{ "type":"object", "properties":{ "ProfileName":{ "description":"The inclusion profile name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Active Directory scan" }, "DeviceZoneID":{ "description":"The device zone ID.", "type":"integer", "example":"1" }, "ProfileStatusID":{ "$ref":"#/components/schemas/discoveryIncludesRead/properties/ProfileStatusID" }, "ProfileTypeID":{ "description":"The profile type ID.\nAllowed values are:\n
  • 1: Ping Scan. The IPRange and CID parameters are also required.
    • \n
  • 2: Seed Scan. The Seeds parameter is also required.
    • \n
  • 3: LDAP Scan. The ServerName, ServerPort, BaseDN, UserDN, UserPass, and Query parameters are also required.
    • \n
  • 4: CDP Scan. The CDPSeeds and Hops parameters are also required.
", "type":"integer", "example":"3" }, "IPRange":{ "$ref":"#/components/schemas/discoveryIncludesRead/properties/IPRange" }, "CIDR":{ "$ref":"#/components/schemas/discoveryIncludesRead/properties/CIDR" }, "Seeds":{ "$ref":"#/components/schemas/discoveryIncludesRead/properties/Seeds" }, "CDPSeeds":{ "$ref":"#/components/schemas/discoveryIncludesRead/properties/CDPSeeds" }, "Query":{ "$ref":"#/components/schemas/discoveryIncludesRead/properties/Query" }, "Hops":{ "$ref":"#/components/schemas/discoveryIncludesRead/properties/Hops" }, "ServerName":{ "$ref":"#/components/schemas/discoveryIncludesRead/properties/ServerName" }, "ServerPort":{ "$ref":"#/components/schemas/discoveryIncludesRead/properties/ServerPort" }, "BaseDN":{ "$ref":"#/components/schemas/discoveryIncludesRead/properties/BaseDN" }, "UserDN":{ "$ref":"#/components/schemas/discoveryIncludesRead/properties/UserDN" }, "UserPass":{ "$ref":"#/components/schemas/discoveryIncludesRead/properties/UserPass" } } }, "discoveryIncludesUpdate":{ "type":"object", "properties":{ "ProfileName":{ "$ref":"#/components/schemas/discoveryIncludes/properties/ProfileName" }, "DeviceZoneID":{ "description":"The device zone ID.", "type":"integer", "example":"1" }, "ProfileStatusID":{ "$ref":"#/components/schemas/discoveryIncludesRead/properties/ProfileStatusID" }, "ProfileTypeID":{ "description":"The profile type ID.\nAllowed values are:\n
  • 1: Ping Scan. The IPRange and CID parameters are updated.
    • \n
  • 2: Seed Scan. The Seeds parameter is updated.
    • \n
  • 3: LDAP Scan. The ServerName, ServerPort, BaseDN, UserDN, UserPass, and Query parameters are updated.
    • \n
  • 4: CDP Scan. The CDPSeeds and Hops parameters are updated.
", "type":"integer", "example":"3" }, "IPRange":{ "$ref":"#/components/schemas/discoveryIncludesRead/properties/IPRange" }, "CIDR":{ "$ref":"#/components/schemas/discoveryIncludesRead/properties/CIDR" }, "Seeds":{ "$ref":"#/components/schemas/discoveryIncludesRead/properties/Seeds" }, "CDPSeeds":{ "$ref":"#/components/schemas/discoveryIncludesRead/properties/CDPSeeds" }, "Query":{ "$ref":"#/components/schemas/discoveryIncludesRead/properties/Query" }, "Hops":{ "$ref":"#/components/schemas/discoveryIncludesRead/properties/Hops" }, "ServerName":{ "$ref":"#/components/schemas/discoveryIncludesRead/properties/ServerName" }, "ServerPort":{ "$ref":"#/components/schemas/discoveryIncludesRead/properties/ServerPort" }, "BaseDN":{ "$ref":"#/components/schemas/discoveryIncludesRead/properties/BaseDN" }, "UserDN":{ "$ref":"#/components/schemas/discoveryIncludesRead/properties/UserDN" }, "UserPass":{ "$ref":"#/components/schemas/discoveryIncludesRead/properties/UserPass" } } }, "discoveryIncludesReadForSelect":{ "type":"object", "properties":{ "ProfileID":{ "$ref":"#/components/schemas/discoveryIncludesRead/properties/ProfileID" }, "ProfileName":{ "$ref":"#/components/schemas/discoveryIncludesRead/properties/ProfileName" } } }, "discoverySNMPRead":{ "type":"object", "properties":{ "Community":{ "description":"The SNMP v1 or v2 community string.", "type":"string", "example":"public" }, "Username":{ "description":"The SNMP v3 user name.", "type":"string", "example":null, "nullable":true }, "SecurityLevel":{ "description":"The SNMP security level for SNMP v3 authentication.\nAllowed values are:\n
  • 0: Not Applicable
    • \n
  • 1: No Authentication and No Privacy
    • \n
  • 2: Authentication and No Privacy
    • \n
  • 3: Authentication and Privacy
", "type":"integer", "example":null, "nullable":true }, "AuthPassword":{ "description":"The SNMP v3 user authentication password.", "type":"string", "example":"*****" }, "AuthProtocol":{ "description":"The SNMP v3 authentication protocol.", "type":"string", "example":null, "nullable":true }, "PrivPassword":{ "description":"The SNMP v3 user privacy password.", "type":"string", "example":"*****" }, "PrivProtocol":{ "description":"The SNMP v3 privacy protocol.", "type":"string", "example":null, "nullable":true }, "SNMPPort":{ "description":"The SNMP UDP port. The default is 161.", "type":"integer", "example":"161" }, "SNMPVersion":{ "description":"The SNMP version.\nAllowed values are:\n
  • 1
    • \n
  • 2
    • \n
  • 3
", "type":"integer", "example":"2" }, "MTU":{ "description":"The maximum transmission unit (MTU) size. The default value is 1472 bytes.", "type":"integer", "example":"1472" }, "DeviceZoneID":{ "description":"The device zone ID.", "type":"integer", "example":"1" }, "DeviceZoneName":{ "description":"The device zone name.", "type":"string", "example":"Default First Zone" }, "DeviceSNMPAccessID":{ "description":"The device SNMP access ID.", "type":"integer", "example":"1" }, "Description":{ "description":"The SNMP Access Profile description.", "type":"string", "example":"Default Public" }, "PriorityOrder":{ "description":"The profile priority order. A lower value means a higher priority. The lowest value is first in the order.", "type":"integer", "example":"0" }, "EngineID":{ "description":"The engine ID. The default is 1.", "type":"integer", "example":null, "nullable":true }, "DeviceCount":{ "description":"The number of devices that match the SNMP access profile.", "type":"integer", "example":"0" } } }, "discoverySNMP":{ "type":"object", "properties":{ "Description":{ "description":"The SNMP Access Profile description.\n
To avoid confusion with numeric IDs, the description value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Default Public" }, "DeviceZoneID":{ "$ref":"#/components/schemas/discoverySNMPRead/properties/DeviceZoneID" }, "SNMPVersion":{ "$ref":"#/components/schemas/discoverySNMPRead/properties/SNMPVersion" }, "Community":{ "$ref":"#/components/schemas/discoverySNMPRead/properties/Community" }, "Username":{ "$ref":"#/components/schemas/discoverySNMPRead/properties/Username" }, "SecurityLevel":{ "$ref":"#/components/schemas/discoverySNMPRead/properties/SecurityLevel" }, "AuthPassword":{ "$ref":"#/components/schemas/discoverySNMPRead/properties/AuthPassword" }, "AuthProtocol":{ "$ref":"#/components/schemas/discoverySNMPRead/properties/AuthProtocol" }, "PrivPassword":{ "$ref":"#/components/schemas/discoverySNMPRead/properties/PrivPassword" }, "PrivProtocol":{ "$ref":"#/components/schemas/discoverySNMPRead/properties/PrivProtocol" }, "MTU":{ "$ref":"#/components/schemas/discoverySNMPRead/properties/MTU" }, "SNMPPort":{ "$ref":"#/components/schemas/discoverySNMPRead/properties/SNMPPort" }, "PriorityOrder":{ "$ref":"#/components/schemas/discoverySNMPRead/properties/PriorityOrder" }, "EngineID":{ "$ref":"#/components/schemas/discoverySNMPRead/properties/EngineID" } } }, "discoverySNMPReadForSelect":{ "type":"object", "properties":{ "DeviceSNMPAccessID":{ "description":"The SNMP access ID of the device.", "type":"integer", "example":"1" }, "Description":{ "description":"The SNMP access description.", "type":"string", "example":"Default Public" } } }, "eventEventsReadData":{ "type":"object", "properties":{ "EventID":{ "description":"The event ID specified for individual read operations.", "type":"integer", "example":"57341" }, "ShardID":{ "description":"The shard ID of the database to query. If no value is specified, the default is 1.", "type":"integer", "example":"1" }, "Node":{ "description":"The name of the device where the event happened. This is usually the DNS name of the device associated with the event.", "type":"string", "example":"router1.example.com" }, "EventType":{ "description":"The type of event. For example, linkUpDown for a linkDown trap.", "type":"string", "example":"Device Down" }, "Summary":{ "description":"The event summary.", "type":"string", "example":"Device Down with availability 0.00% == 0%" }, "Count":{ "description":"The number of times this event has happened (deduplicated).", "type":"integer", "example":"1963" }, "FirstReported":{ "description":"The timestamp when the event was first reported.", "type":"string", "example":"2022-10-31 10:40:00.000" }, "LastReported":{ "description":"The timestamp when the event was last reported.", "type":"string", "example":"2023-08-10 01:10:00.000" }, "LastChanged":{ "description":"The timestamp when the event was last changed.", "type":"string", "example":"2023-08-10 01:10:00.000" }, "EventKey":{ "description":"The event key.", "type":"string", "example":"Standard Threshold-router1.example.com-Device Down-Device" }, "EventCategory":{ "description":"The event category.\nAllowed values are:\n
  • Resolution
    • \n
  • Problem
    • \n
  • Discrete
", "type":"string", "example":"Problem" }, "Ack":{ "description":"Whether the event has been acknowledged (1) or not (0). Events will be displayed differently based on whether or not they have been acknowledged.", "type":"integer", "example":"1" }, "Action":{ "description":"The non-human entity that caused a change to be made.", "type":"string", "example":"SQL Tool: Acknowledge" }, "Actor":{ "description":"The entity or user that caused the change to be made.", "type":"string", "example":"admin" }, "Customer":{ "description":"Customer can be set to a value when needed.", "type":"string", "example":"" }, "Department":{ "description":"Customer.rules will set this to Unknown if not previously set.", "type":"string", "example":"Unknown" }, "Details":{ "description":"Details of the event in JSON format.", "type":"string", "example":"{\"ThresholdName\":\"Device Down\",\"Time\":\"1667230800\",\"InstanceName\":\"Device\",\"ThresholdTimeRange\":900,\"ThresholdTypeName\":\"StandardThreshold\",\"ThresholdSeverity\":5,\"MetricValue\":0,\"ThresholdOperator\":\"==\",\"DeviceName\":\"router.example.com\",\"ThresholdType\":\"1\",\"ThresholdMessage\":\"Performance threshold violation: Device Down\",\"Measurement\":\"metrictype_Latency\",\"ThresholdValue\":\"0\"}" }, "DeviceType":{ "description":"Device Type is used as a general category for the event. Customer.rules will set this to Unknown if not previously set.", "type":"string", "example":"Unknown" }, "Duration":{ "description":"Duration for which the event occurred (LastReported - FirstReported)", "type":"number", "example":"24417000.000" }, "EscalationFlag":{ "description":"Whether the event should or has been escalated. Can be:\n
  • 0: Should not be escalated.
    • \n
  • 1: Should be escalated.
    • \n
  • 2: Has been escalated.
", "type":"integer", "example":"0" }, "ExpireTime":{ "description":"Time at which the event expired (Number of seconds after LastChanged for this Event to become eligible-to-be-deleted, which is done by the mechanization DeleteExpired)", "type":"integer", "example":"0" }, "GeoPath":{ "description":"An object containing a pair of longitude and latitude coordinates denoting a geographic path related to the event.", "type":"string", "example":"{\"type\": \"LineString\", \"coordinates\": [[0.0, 0.0], [0.0, 0.0]]}" }, "GeoLocation":{ "description":"An object containing a longitude and latitude denoting a geographic location related to the event.", "type":"string", "example":"{\"type\": \"Point\", \"coordinates\": [0.0, 0.0]}" }, "IPAddress":{ "description":"The IPv4 or IPv6 address of the Device associated with this Event", "type":"string", "example":"100.77.1.4" }, "Location":{ "description":"Name, Address, or something similar associated with the Event. Observability Analytics uses this if it is set.", "type":"string", "example":"" }, "Method":{ "description":"Protocol of how the event was received/retrieved. The binary will set a default value (Trapd, Syslogd, for example), but can be update in rules, if needed.", "type":"string", "example":"StandardThresholdEngined" }, "OrigSeverity":{ "description":"The original severity when the event was first created.", "type":"integer", "example":"5" }, "OwnerName":{ "description":"The name of the currently-responsible person. Some event Tools (for example, \"Acknowledge\", \"Delete\", and \"Take Ownership\") set this to the username that executed the tool; \"UnAcknowledge\" sets it to 0.", "type":"string", "example":"admin" }, "RootCauseFlag":{ "description":"Used by applications to know whether the event is being processed as a root cause of another event or not.", "type":"integer", "example":"0" }, "RootCauseID":{ "description":"Used by applications to know whether the event was caused by another event or not.", "type":"integer", "example":"0" }, "Score":{ "description":"If a Priority value is set on a device, this field can be set to the event Severity * Priority to increase the number. Event Filters can be configured to show the hi-score Events first, or other processing may utilize this value.", "type":"integer", "example":"0" }, "Service":{ "description":"The SLM applications will set this to the name of the SLM Service if a violation is detected.", "type":"string", "example":"" }, "ServiceImpact":{ "description":"Flag to indicate a provided service has been impacted. \nAllowed values: \n
  • 0: Not service impacting
    • \n
  • 1: Service impacting
", "type":"integer", "example":"0" }, "Severity":{ "description":"Must be a value between 0 and 5. The event will change colors in the Event List based on the severity.\nAllowed Values:\n- 0 => Normal\n- 1 => Unknown\n- 2 => Info\n- 3 => Minor\n- 4 => Major\n- 5 => Critical", "type":"string", "example":"Critical" }, "SubDeviceType":{ "description":"Used for vendor or model information for the event. Customer.rules will set this to Unknown if not previously set.", "type":"string", "example":"Unknown" }, "SubMethod":{ "description":"Usually set in rules to the specific processing that was done on the event, for example, the MIB that defines the trap, or the string \"watchdog\", or \"Unknown\".", "type":"string", "example":"Standard Threshold" }, "SubNode":{ "description":"The Instance of the Event, for example, the ifIndex value of a linkUp trap. Mechanization CorrelateProblemResolutions requires that this is the same for correlating events", "type":"string", "example":"Device" }, "TicketFlag":{ "description":"A flag for the ticket state of this event. \n- 0 = no ticket\n- 1 = ticket to be created\n- 2 = processing\n- 3 = opened", "type":"integer", "example":"0" }, "TicketID":{ "description":"The Ticket ID associated with this Event in the external system. Should be populated by the process done to open the ticket in the external system.", "type":"integer", "example":"" }, "ZoneID":{ "description":"Can be set to the Device Zone that the device is in.", "type":"integer", "example":"5" } } }, "eventEventsReadMetaData":{ "type":"object", "properties":{ "root":{ "description":"root", "type":"string", "example":"data" }, "fields":{ "description":"fields within the data object (Events)", "type":"array", "items":{ "type":"string" }, "example":[ "EventID", "ShardID", "Node", "EventType", "Summary", "Count", "FirstReported", "LastReported", "LastChanged", "EventKey", "EventCategory", "Ack", "Action", "Actor", "Customer", "Department", "Details", "DeviceType", "Duration", "EscalationFlag", "ExpireTime", "GeoPath", "GeoLocation", "IPAddress", "Location", "Method", "OrigSeverity", "OwnerName", "RootCauseFlag", "RootCauseID", "Score", "Service", "ServiceImpact", "Severity", "SubDeviceType", "SubMethod", "SubNode", "TicketFlag", "TicketID", "ZoneID" ] }, "columns":{ "type":"array", "items":{ "type":"object" }, "example":[ { "text":"
", "tooltip":"Indicates correlated symptom events", "dataIndex":"RootCauseFlag", "align":"left", "filter":false, "sortable":false, "hidden":false, "menuDisabled":true, "width":34 }, { "header":"EventID", "dataIndex":"EventID", "align":"left", "filter":"int", "hidden":true, "width":100 }, { "header":"ShardID", "dataIndex":"ShardID", "align":"left", "filter":"int", "hidden":true, "width":60 }, { "header":"Device", "dataIndex":"Node", "align":"left", "filter":"string", "hidden":false, "width":300 }, { "header":"Event Type", "dataIndex":"EventType", "align":"left", "filter":"string", "hidden":false, "width":200 }, { "header":"Event Text", "dataIndex":"Summary", "align":"left", "filter":"string", "hidden":false, "flex":1, "minWidth":100 }, { "header":"Count", "dataIndex":"Count", "align":"center", "filter":"int", "hidden":false, "width":70 }, { "header":"First Occurred", "dataIndex":"FirstReported", "align":"center", "filter":"datetime", "hidden":false, "width":190 }, { "header":"Last Occurred", "dataIndex":"LastReported", "align":"center", "filter":"datetime", "hidden":false, "width":190 }, { "header":"Last Changed", "dataIndex":"LastChanged", "align":"center", "filter":"datetime", "hidden":true, "width":120 }, { "header":"EventKey", "dataIndex":"EventKey", "align":"left", "filter":"string", "hidden":true, "width":120 }, { "header":"EventCategory", "dataIndex":"EventCategory", "align":"left", "filter":"string", "hidden":true, "width":120 }, { "header":"Ack", "dataIndex":"Ack", "align":"left", "filter":"string", "hidden":true, "width":120 }, { "header":"Action", "dataIndex":"Action", "align":"left", "filter":"string", "hidden":true, "width":120 }, { "header":"Actor", "dataIndex":"Actor", "align":"left", "filter":"string", "hidden":true, "width":120 }, { "header":"Customer", "dataIndex":"Customer", "align":"left", "filter":"string", "hidden":true, "width":120 }, { "header":"Department", "dataIndex":"Department", "align":"left", "filter":"string", "hidden":true, "width":120 }, { "header":"Details", "dataIndex":"Details", "align":"left", "filter":"string", "hidden":true, "width":120 }, { "header":"DeviceType", "dataIndex":"DeviceType", "align":"left", "filter":"string", "hidden":true, "width":120 }, { "header":"Duration", "dataIndex":"Duration", "align":"left", "filter":"string", "hidden":true, "width":120 }, { "header":"EscalationFlag", "dataIndex":"EscalationFlag", "align":"left", "filter":"string", "hidden":true, "width":120 }, { "header":"ExpireTime", "dataIndex":"ExpireTime", "align":"left", "filter":"string", "hidden":true, "width":120 }, { "header":"GeoPath", "dataIndex":"GeoPath", "align":"left", "filter":"string", "hidden":true, "width":120 }, { "header":"GeoLocation", "dataIndex":"GeoLocation", "align":"left", "filter":"string", "hidden":true, "width":120 }, { "header":"IPAddress", "dataIndex":"IPAddress", "align":"left", "filter":"string", "hidden":true, "width":120 }, { "header":"Location", "dataIndex":"Location", "align":"left", "filter":"string", "hidden":true, "width":120 }, { "header":"Method", "dataIndex":"Method", "align":"left", "filter":"string", "hidden":true, "width":120 }, { "header":"OrigSeverity", "dataIndex":"OrigSeverity", "align":"left", "filter":"string", "hidden":true, "width":120 }, { "header":"OwnerName", "dataIndex":"OwnerName", "align":"left", "filter":"string", "hidden":true, "width":120 }, { "header":"RootCauseFlag", "dataIndex":"RootCauseFlag", "align":"left", "filter":"string", "hidden":true, "width":120 }, { "header":"RootCauseID", "dataIndex":"RootCauseID", "align":"left", "filter":"string", "hidden":true, "width":120 }, { "header":"Score", "dataIndex":"Score", "align":"left", "filter":"string", "hidden":true, "width":120 }, { "header":"Service", "dataIndex":"Service", "align":"left", "filter":"string", "hidden":true, "width":120 }, { "header":"ServiceImpact", "dataIndex":"ServiceImpact", "align":"left", "filter":"string", "hidden":true, "width":120 }, { "header":"Severity", "dataIndex":"Severity", "align":"left", "filter":"string", "hidden":true, "width":120 }, { "header":"SubDeviceType", "dataIndex":"SubDeviceType", "align":"left", "filter":"string", "hidden":true, "width":120 }, { "header":"SubMethod", "dataIndex":"SubMethod", "align":"left", "filter":"string", "hidden":true, "width":120 }, { "header":"SubNode", "dataIndex":"SubNode", "align":"left", "filter":"string", "hidden":true, "width":120 }, { "header":"TicketFlag", "dataIndex":"TicketFlag", "align":"left", "filter":"string", "hidden":true, "width":120 }, { "header":"TicketID", "dataIndex":"TicketID", "align":"left", "filter":"string", "hidden":true, "width":120 }, { "header":"ZoneID", "dataIndex":"ZoneID", "align":"left", "filter":"string", "hidden":true, "width":120 } ] }, "severity":{ "description":"Object containing number of all type of severities", "type":"object", "example":{ "normal":11, "unknown":1, "info":1, "minor":1620, "major":809, "critical":165, "all":2607, "sum":130887185 } } } }, "eventCustomEventFields":{ "type":"object", "properties":{ "FieldName":{ "type":"string", "description":"The custom event field name.", "example":"Example" }, "FieldType":{ "type":"string", "description":"The custom event field data type.", "example":"TIMESTAMP" }, "FieldTypeSize":{ "type":"integer", "description":"The maximum size of the field. This field is used only for some string-type fields. String-type fields such as CHAR have a maximum length that can be specified. If no value is provided, the database will determine the size.", "example":"" }, "FieldTypePrecision":{ "type":"string", "description":"The maximum length of the field, in decimal precision notation. Only used for some number-type fields, such as DECIMAL. Use the format (<p>,<s>), where <p> is the total maximum number of digits, and <s> is the maximum number of that total that can appear after the decimal point.
\nThis field is required for all event types, but you can set it to an empty string (\"\") when it is not relevant.", "example":"" }, "IndexType":{ "type":"string", "description":"The short code for the index type. For example, MUL for Standard or <None> for no index type.", "example":"MUL" }, "DefaultNull":{ "type":"boolean", "description":"Indicates if the default value is null (1) or not (0). This field is required for all field types, but you can set it to an empty string (\"\") which will set its value as 0.", "example":"0" }, "DefaultValue":{ "type":"string", "description":"The custom event field default value. It can be a literal value based on the field type or an expression. This field is required for all field types, but you can set it to an empty string (\"\")", "example":"CURRENT_TIMESTAMP" }, "DefaultAsExpression":{ "type":"boolean", "description":"Indicates if the default value is an expression (1) or literal (0). This field is required for all field types, but you can set it to an empty string (\"\") which will set its value as 0.", "example":"1" } } }, "eventCustomEventFieldsReadByID":{ "type":"object", "properties":{ "EventSchemaID":{ "type":"integer", "description":"The custom event field ID.", "example":"2" }, "FieldName":{ "type":"string", "description":"The custom event field name.", "example":"Example" }, "FieldType":{ "type":"string", "description":"The custom event field data type.", "example":"TIMESTAMP" }, "IndexTypeDisplayName":{ "type":"string", "description":"Human-readable name for the index type. For example, Standard.", "example":"Standard" }, "IndexType":{ "type":"string", "description":"The short code for the index type. For example, MUL for Standard or <None> for no index type.", "example":"MUL" }, "DefaultNull":{ "type":"boolean", "description":"Indicates if the default value is null (1) or not (0).", "example":"0" }, "DefaultValue":{ "type":"string", "description":"Default value for the field. It can be a literal value based on the field type or an expression.", "example":"CURRENT_TIMESTAMP" }, "DefaultAsExpression":{ "type":"boolean", "description":"Indicates if the default value is an expression (1) or literal (0).", "example":"1" } } }, "eventCustomEventFieldsReadForSelect":{ "type":"object", "properties":{ "EventSchemaID":{ "description":"The custom event field ID.", "type":"integer", "example":"1" }, "FieldName":{ "description":"The custom event field name.", "type":"string", "example":"Example" } } }, "eventEventsReadByID":{ "type":"object", "properties":{ "EventID":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/EventID" } ], "example":7948575 }, "EventKey":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/EventKey" } ], "example":"Standard Threshold-pg-453200.example.com-Device Down-Device" }, "EventCategory":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/EventCategory" } ], "example":"Problem" }, "EventType":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/EventType" } ], "example":"Problem" }, "Ack":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/Ack" } ], "example":"0" }, "Action":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/Action" } ], "example":"" }, "Actor":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/Actor" } ], "example":"" }, "Count":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/Count" } ], "example":"23428" }, "Customer":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/Customer" } ], "example":"" }, "Department":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/Department" } ], "example":"Unknown" }, "Details":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/Details" } ], "example":"{\"ThresholdName\":\"Device Down\",\"Time\":\"1691741100\",\"InstanceName\":\"Device\",\"ThresholdTimeRange\":\"900\",\"ThresholdTypeName\":\"Standard Threshold\",\"ThresholdSeverity\":\"5\",\"MetricValue\":0,\"ThresholdOperator\":\"==\",\"DeviceName\":\"example.com\",\"ThresholdType\":\"1\",\"ThresholdMessage\":\"Performance threshold violation: Device Down\",\"Measurement\":\"metrictype_Latency\",\"ThresholdValue\":\"0\"}" }, "DeviceType":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/DeviceType" } ], "example":"Unknown" }, "Duration":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/Duration" } ], "example":"7009800.000" }, "EscalationFlag":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/EscalationFlag" } ], "example":"0" }, "ExpireTime":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/ExpireTime" } ], "example":"0" }, "FirstReported":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/FirstReported" } ], "example":"2023-08-11 03:05:00.000" }, "GeoPath":{ "description":"An object containing a pair of longitude and latitude coordinates denoting a geographic path related to the event.", "type":"object", "properties":{ "type":{ "example":"LineString" }, "coordinates":{ "example":[ [ 0, 0 ], [ 0, 0 ] ] } } }, "GeoLocation":{ "description":"An object containing a longitude and latitude denoting a geographic location related to the event.", "type":"object", "properties":{ "type":{ "example":"Point" }, "coordinates":{ "example":[ 0, 0 ] } } }, "IPAddress":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/IPAddress" } ], "example":"100.77.220.51" }, "LastChanged":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/LastChanged" } ], "example":"2023-10-31 06:15:00.000" }, "LastReported":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/LastReported" } ], "example":"2023-10-31 06:15:00.000" }, "Location":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/Location" } ], "example":"" }, "Method":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/Method" } ], "example":"StandardThresholdEngined" }, "Node":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/Node" } ], "example":"example.com" }, "OrigSeverity":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/OrigSeverity" } ], "example":"5" }, "OwnerName":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/OwnerName" } ], "example":"" }, "RootCauseFlag":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/RootCauseFlag" } ], "example":"0" }, "RootCauseID":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/RootCauseID" } ], "example":"0" }, "Score":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/Score" } ], "example":"0" }, "Service":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/Service" } ], "example":"" }, "ServiceImpact":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/ServiceImpact" } ], "example":"0" }, "Severity":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/Severity" } ], "example":"5" }, "SubDeviceType":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/SubDeviceType" } ], "example":"Unknown" }, "SubMethod":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/SubMethod" } ], "example":"Standard Threshold" }, "SubNode":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/SubNode" } ], "example":"Device" }, "Summary":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/Summary" } ], "example":"Device Down with availability 0.00% == 0%" }, "TicketFlag":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/TicketFlag" } ], "example":"0" }, "TicketID":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/TicketID" } ], "example":"" }, "ZoneID":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/ZoneID" } ], "example":"3" }, "ShardID":{ "allOf":[ { "$ref":"#/components/schemas/eventEventsReadData/properties/ShardID" } ], "example":"1" }, "EventCategoryHasConversion":{ "description":"Event Category had conversion", "type":"integer", "example":1 }, "EventCategoryRaw":{ "description":"Event category", "type":"integer", "example":2 } } }, "eventEventsReadByIDMetaData":{ "type":"array", "items":{ "type":"object" }, "example":[ { "EventID":"7948575", "Node":"example.com", "EventType":"Device Down", "Summary":"Device Down with availability 0.00% == 0%", "Count":"20012", "FirstReported":"2023-08-11 03:05:00.000", "LastReported":"2023-10-19 05:45:00.000", "LastChanged":"2023-10-19 05:45:00.000", "EventKey":"Standard Threshold-example.com-Device Down-Device", "EventCategory":"Problem", "Ack":"0", "Action":"", "Actor":"", "Customer":"", "Department":"Unknown", "Details":"{\"ThresholdName\":\"Device Down\",\"Time\":\"1691741100\",\"InstanceName\":\"Device\",\"ThresholdTimeRange\":\"900\",\"ThresholdTypeName\":\"Standard Threshold\",\"ThresholdSeverity\":\"5\",\"MetricValue\":0,\"ThresholdOperator\":\"==\",\"DeviceName\":\"example.com\",\"ThresholdType\":\"1\",\"ThresholdMessage\":\"Performance threshold violation: Device Down\",\"Measurement\":\"metrictype_Latency\",\"ThresholdValue\":\"0\"}", "DeviceType":"Unknown", "Duration":"5971200.000", "EscalationFlag":"0", "ExpireTime":"0", "GeoPath":"{\"type\": \"LineString\", \"coordinates\": [[0.0, 0.0], [0.0, 0.0]]}", "GeoLocation":"{\"type\": \"Point\", \"coordinates\": [0.0, 0.0]}", "IPAddress":"100.77.220.51", "Location":"", "Method":"StandardThresholdEngined", "OrigSeverity":"5", "OwnerName":"", "RootCauseFlag":"0", "RootCauseID":"0", "Score":"0", "Service":"", "ServiceImpact":"0", "Severity":"5", "SubDeviceType":"Unknown", "SubMethod":"Standard Threshold", "SubNode":"Device", "TicketFlag":"0", "TicketID":"", "ZoneID":"3", "ShardID":"1" }, { "EventID":{ "displayName":"EventID ", "editor":"{\"xtype\":\"numberfield\"}" }, "Node":{ "displayName":"Device", "editor":"{\"xtype\":\"textfield\"}" }, "EventType":{ "displayName":"Event Type", "editor":"{\"xtype\":\"textfield\"}" }, "Summary":{ "displayName":"Event Text", "editor":"{\"xtype\":\"textfield\"}" }, "Count":{ "displayName":"Count ", "editor":"{\"xtype\":\"numberfield\"}" }, "FirstReported":{ "displayName":"First Occurred ", "editor":"{\"xtype\":\"timedatefield\"}" }, "LastReported":{ "displayName":"Last Occurred ", "editor":"{\"xtype\":\"timedatefield\"}" }, "LastChanged":{ "displayName":"Last Changed ", "editor":"{\"xtype\":\"timedatefield\"}" }, "EventKey":{ "displayName":"EventKey ", "editor":"{\"xtype\":\"textfield\"}" }, "EventCategory":{ "displayName":"EventCategory", "editor":"{\"xtype\":\"eventcategorycombo\"}" }, "Ack":{ "displayName":"Ack", "editor":"{\"xtype\":\"textfield\"}" }, "Action":{ "displayName":"Action ", "editor":"{\"xtype\":\"textfield\"}" }, "Actor":{ "displayName":"Actor ", "editor":"{\"xtype\":\"textfield\"}" }, "Customer":{ "displayName":"Customer", "editor":"{\"xtype\":\"textfield\"}" }, "Department":{ "displayName":"Department", "editor":"{\"xtype\":\"textfield\"}" }, "Details":{ "displayName":"Details", "editor":"{\"xtype\":\"textfield\"}" }, "DeviceType":{ "displayName":"DeviceType", "editor":"{\"xtype\":\"textfield\"}" }, "Duration":{ "displayName":"Duration", "editor":"{\"xtype\":\"textfield\"}" }, "EscalationFlag":{ "displayName":"EscalationFlag", "editor":"{\"xtype\":\"textfield\"}" }, "ExpireTime":{ "displayName":"ExpireTime", "editor":"{\"xtype\":\"textfield\"}" }, "GeoPath":{ "displayName":"GeoPath", "editor":"{\"xtype\":\"textfield\"}" }, "GeoLocation":{ "displayName":"GeoLocation", "editor":"{\"xtype\":\"textfield\"}" }, "IPAddress":{ "displayName":"IPAddress", "editor":"{\"xtype\":\"textfield\"}" }, "Location":{ "displayName":"Location", "editor":"{\"xtype\":\"textfield\"}" }, "Method":{ "displayName":"Method", "editor":"{\"xtype\":\"textfield\"}" }, "OrigSeverity":{ "displayName":"OrigSeverity", "editor":"{\"xtype\":\"textfield\"}" }, "OwnerName":{ "displayName":"OwnerName", "editor":"{\"xtype\":\"textfield\"}" }, "RootCauseFlag":{ "displayName":"RootCauseFlag", "editor":"{\"xtype\":\"textfield\"}" }, "RootCauseID":{ "displayName":"RootCauseID", "editor":"{\"xtype\":\"textfield\"}" }, "Score":{ "displayName":"Score", "editor":"{\"xtype\":\"textfield\"}" }, "Service":{ "displayName":"Service", "editor":"{\"xtype\":\"textfield\"}" }, "ServiceImpact":{ "displayName":"ServiceImpact", "editor":"{\"xtype\":\"textfield\"}" }, "Severity":{ "displayName":"Severity", "editor":"{\"xtype\":\"severitycombo\"}" }, "SubDeviceType":{ "displayName":"SubDeviceType", "editor":"{\"xtype\":\"textfield\"}" }, "SubMethod":{ "displayName":"SubMethod", "editor":"{\"xtype\":\"textfield\"}" }, "SubNode":{ "displayName":"SubNode", "editor":"{\"xtype\":\"textfield\"}" }, "TicketFlag":{ "displayName":"TicketFlag", "editor":"{\"xtype\":\"textfield\"}" }, "TicketID":{ "displayName":"TicketID", "editor":"{\"xtype\":\"textfield\"}" }, "ZoneID":{ "displayName":"ZoneID", "editor":"{\"xtype\":\"textfield\"}" }, "ShardID":{ "displayName":"ShardID", "editor":"{\"xtype\":\"numberfield\"}" } } ] }, "eventEventsReadFields":{ "type":"object", "properties":{ "Field":{ "description":"Field Name", "type":"string", "example":"EventID" }, "Type":{ "description":"Type of the particular field", "type":"string", "example":"Number" }, "Null":{ "description":"If the field can be null or not", "type":"string", "example":"NO" }, "Key":{ "description":"Type of database index associated with the field.", "type":"string", "example":"PRI" }, "Default":{ "description":"Default value for the field", "type":"string", "example":"" }, "Extra":{ "description":"Extra information from the database field definition.", "type":"string", "example":"auto_increment" }, "ColumnName":{ "description":"Column name for the field as defined by the display.", "type":"string", "example":"EventID" }, "Expression":{ "description":"Type of data in the column. Allowed Values- Number, String", "type":"string", "example":"Number" }, "FieldDescription":{ "description":"Combination of the Field and Type concatenated with a hyphen", "type":"string", "example":"EventID - Number" } } }, "eventEventsReadFieldsForSelect":{ "type":"object", "properties":{ "Field":{ "description":"Field Name", "type":"string", "example":"Ack" }, "FieldDescription":{ "description":"Field Description", "type":"string", "example":"Ack - tinyint unsigned" }, "Type":{ "description":"Field Type", "type":"string", "example":"tinyint unsigned" } } }, "eventDisplayConversionRead":{ "type":"object", "properties":{ "FieldID":{ "description":"Name of Events field.", "type":"string", "example":"EventCategory" }, "Field":{ "description":"Name of Events field", "type":"string", "example":"EventCategory" }, "ConversionCount":{ "description":"The number of conversions related to the field", "type":"integer", "example":"3" }, "Conversions":{ "description":"List of unordered conversions for the given field. Array of field value conversion mappings", "type":"array", "items":{ "type":"object", "properties":{ "CompareValue":{ "description":"DB value in the Event database in the related field", "type":"integer", "example":1 }, "DisplayValue":{ "description":"Converted value the user will see instead of the raw DB value", "type":"string", "example":"Resolution" } } }, "example":[ { "CompareValue":1, "DisplayValue":"Resolution" }, { "CompareValue":2, "DisplayValue":"Problem" }, { "CompareValue":3, "DisplayValue":"Discrete" } ] } } }, "eventDisplayConversionReadFieldsForSelect":{ "type":"object", "properties":{ "Field":{ "description":"Name of Events field", "type":"string", "example":"EventCategory" }, "FieldDescription":{ "description":"Description of the field in the Event database Events table", "type":"string", "example":"EventCategory - tinyint unsigned" }, "Type":{ "description":"Type for the field", "type":"string", "example":"tinyint unsigned" } } }, "eventDisplayConversionsReadForSelect":{ "type":"object", "properties":{ "CompareValue":{ "description":"DB value in the Event database in the related field", "type":"integer", "example":"1" }, "DisplayValue":{ "description":"Converted value the user will see instead of the raw DB value", "type":"string", "example":"Resolution" } } }, "eventDisplayConversion":{ "type":"object", "properties":{ "Field":{ "$ref":"#/components/schemas/eventDisplayConversionRead/properties/Field" }, "Conversions":{ "$ref":"#/components/schemas/eventDisplayConversionRead/properties/Conversions" } } }, "eventDisplayRead":{ "type":"object", "properties":{ "DisplayID":{ "description":"Display ID specified for individual CRUD operations", "type":"integer", "example":"1" }, "DisplayName":{ "description":"The name of display", "type":"string", "example":"Default" }, "OwnerUserID":{ "description":"The ID of the user that owns the event display. This can never be an externally-authenticated transient user. 0 means it is public to all users in the owning group.", "type":"integer", "example":"0" }, "OwnerUserGroupID":{ "description":"The ID of the user group owner.", "oneOf":[ { "type":"integer" }, { "type":"string" } ], "example":"0" }, "DisableConversions":{ "description":"Toggles whether to disable conversions when viewing events with this display", "type":"integer", "example":"0" }, "DisplayColumnsGrid":{ "description":"A list of columns visible in the display", "type":"string", "example":"Device\n
Event Type\n
Event Text\n
Count\n
First Occurred\n
Last Occurred" }, "Owner":{ "description":"Defines the user that owns the display.", "type":"string", "example":"[Public to All Users and Groups]" }, "Viewers":{ "description":"List of user groups that can view", "type":"array", "items":{ "type":"object", "properties":{ "UserGroupID":{ "description":"The user group ID.", "type":"integer" }, "UserGroupName":{ "description":"The user group name.", "type":"string" } } }, "example":[ ] }, "DisplayColumns":{ "description":"Object of Columns and Orders", "type":"object", "properties":{ "Order":{ "description":"SQL sort by clause specifying which fields are sorted in which direction.", "type":"string", "example":"[Public to All Users and Groups]" }, "Columns":{ "description":"Lists of all the fields available within the Events database.", "type":"array", "items":{ "$ref":"#/components/schemas/eventDisplayReadColumn" } } } } } }, "eventDisplayReadColumn":{ "type":"object", "properties":{ "Visible":{ "description":"Checkbox to indicate the field will be visible when the event list is displayed.", "type":"boolean", "example":false }, "ColumnField":{ "description":"Field name in the Events table", "type":"boolean", "example":"false" }, "ColumnName":{ "description":"Custom name specified for the Field", "type":"string", "example":"EventID" }, "ColumnWidth":{ "description":"Column width when the event list is displayed", "type":"number", "example":"100" }, "ColumnAlign":{ "description":"Column content alignment, ex. Left, Center or Right", "type":"string", "example":"Left" }, "ColumnType":{ "description":"Type in which content is rendered", "type":"string", "example":"Number" }, "Editable":{ "description":"Checkbox to indicate the field can be edited in the expanded event in the event list.", "type":"boolean", "example":true }, "Filterable":{ "description":"Checkbox to indicate the field can be filtered when filtering the event list.", "type":"boolean", "example":true }, "Sortable":{ "description":"Checkbox to indicate the field can be sorted when sorting the event list.", "type":"boolean", "example":true } } }, "eventDisplay":{ "type":"object", "properties":{ "DisplayName":{ "description":"The name for the event display.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Default" }, "OwnerUserID":{ "$ref":"#/components/schemas/eventDisplayRead/properties/OwnerUserID" }, "OwnerUserGroupID":{ "$ref":"#/components/schemas/eventDisplayRead/properties/OwnerUserGroupID" }, "DisableConversions":{ "$ref":"#/components/schemas/eventDisplayRead/properties/DisableConversions" }, "DisplayColumns":{ "$ref":"#/components/schemas/eventDisplayRead/properties/DisplayColumns" }, "Viewers":{ "$ref":"#/components/schemas/eventDisplayRead/properties/Viewers" } } }, "eventDisplaysReadForSelect":{ "type":"object", "properties":{ "DisplayID":{ "$ref":"#/components/schemas/eventDisplayRead/properties/DisplayID" }, "DisplayName":{ "$ref":"#/components/schemas/eventDisplayRead/properties/DisplayName" } } }, "eventDisplayReadAllColumns":{ "type":"object", "properties":{ "DisplayColumns":{ "$ref":"#/components/schemas/eventDisplayRead/properties/DisplayColumns" } } }, "eventEventJournalsRead":{ "type":"object", "properties":{ "JournalID":{ "description":"Journal ID", "type":"integer", "example":251 }, "JournalUsername":{ "description":"Name of the user that created the journal entry.", "type":"string", "example":"admin" }, "JournalTimeStamp":{ "description":"Timestamp when the journal entry was created.", "type":"string", "example":"2022-11-06T11:17:48.000Z" }, "JournalEntry":{ "description":"The text of the journal entry.", "type":"string", "example":"Event Acknowledged" }, "JournalActor":{ "description":"The actor that added the journal. By default, this is the user who made the request.", "type":"string", "example":"operator" }, "JournalAction":{ "description":"The action that added the journal.", "type":"string", "example":"Manual journal entry by user" } } }, "eventEventJournals":{ "type":"object", "properties":{ "EventID":{ "description":"The ID of the event the new journal entry will be attached to.", "type":"integer" }, "Events":{ "description":"A comma-separated list of event IDs. Any API action included applies to all events.", "type":"array", "items":{ "type":"object" } }, "JournalEntry":{ "description":"The text of the journal entry. If not specified, defaults to ''.", "type":"string" }, "JournalActor":{ "description":"The actor adding the journal. If not specified, defaults to the user making the request.", "type":"string", "example":"operator" }, "JournalAction":{ "description":"The action adding the journal. If not specified, defaults to Manual journal entry by user.", "type":"string", "example":"Manual journal entry by user" } } }, "eventFiltersRead":{ "type":"object", "properties":{ "FilterID":{ "description":"Filter ID specified for individual CRUD operations", "type":"integer", "example":"1" }, "FilterName":{ "description":"Filter Name", "type":"string", "example":"Acked Events" }, "Filter":{ "description":"Filter Where clause", "type":"string", "example":"Ack=1" }, "OwnerUserID":{ "description":"The ID of the user that owns the event filter. This can never be an externally-authenticated transient user. 0 means it is public to all users in the owning group.", "type":"integer", "example":"0" }, "OwnerUserGroupID":{ "description":"Chosen user group owner", "type":"integer", "example":"0" }, "ShardID":{ "description":"Shard ID to run the filter against", "type":"integer", "example":"1" }, "ShowSymptoms":{ "description":"Flag indicating whether or not to show events that have been marked as a symptom.", "type":"integer", "example":"0" }, "DisplayID":{ "description":"ID of the display to use with the filter.", "type":"integer", "example":"0" }, "DisplayName":{ "description":"Name of the display to use with the filter.", "type":"string", "example":"[User Default]" }, "Owner":{ "description":"Defines the user that owns the display.", "type":"string", "example":"[Public to All Users and Groups]" }, "Viewers":{ "description":"List of user groups that can view", "type":"array", "items":{ "type":"object", "properties":{ "UserGroupID":{ "description":"The user group ID.", "type":"integer" }, "UserGroupName":{ "description":"The user group name.", "type":"string" } } }, "example":[ ] } } }, "eventFilters":{ "type":"object", "properties":{ "FilterName":{ "description":"The event filter name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Acked Events" }, "OwnerUserID":{ "description":"The ID of the user that owns the event filter. This can never be an externally-authenticated transient user. 0 means it is public to all users in the owning group.", "type":"integer", "example":"0" }, "OwnerUserGroupID":{ "description":"Chosen user group owner", "type":"integer", "example":"0" }, "Filter":{ "$ref":"#/components/schemas/eventFiltersRead/properties/Filter" }, "DisplayID":{ "$ref":"#/components/schemas/eventFiltersRead/properties/DisplayID" }, "ShardID":{ "$ref":"#/components/schemas/eventFiltersRead/properties/ShardID" }, "ShowSymptoms":{ "description":"Flag indicating whether or not to show events that have been marked as a symptom.", "type":"integer" }, "Viewers":{ "$ref":"#/components/schemas/eventFiltersRead/properties/Viewers" } } }, "eventFiltersReadForSelect":{ "type":"object", "properties":{ "FilterID":{ "description":"Filter ID specified for individual CRUD operations", "type":"integer", "example":"1" }, "FilterName":{ "description":"Filter Name", "type":"string", "example":"Acked Events" }, "DisplayID":{ "description":"ID of the display to use with the filter.", "type":"integer", "example":"0" }, "FilterGroupID":{ "description":"ID of the filter group the filter belongs to.", "type":"integer", "example":"1" } } }, "eventFilterGroupsRead":{ "type":"object", "properties":{ "FilterGroupID":{ "description":"Child filter group ID.", "type":"integer", "example":"5" }, "DisplayName":{ "description":"Name of the child filter group.", "type":"string", "example":"Oracle" }, "ParentFilterGroupID":{ "description":"ID of the parent filter group.", "type":"integer", "example":"3" }, "cls":{ "description":"Class for the UI decoration.", "type":"string", "example":"folder" } } }, "eventFilterGroupsReadByID":{ "type":"object", "properties":{ "FilterGroupName":{ "description":"Filter Group Name", "type":"string", "example":"Global" }, "OwnerUserID":{ "description":"The ID of the user that owns the event filter group. This can never be an externally-authenticated transient user. 0 means it is public to all users in the owning group.", "type":"integer", "example":"0" }, "OwnerUserGroupID":{ "description":"Chosen user group owner", "type":"integer", "example":"0" }, "RestrictionFilter":{ "description":"Restriction filter", "type":"string", "example":"" }, "FilterGroupID":{ "description":"Filter Group ID", "type":"integer", "example":"1" }, "ParentFilterGroupID":{ "description":"FilterGroupID of Parent Group, can be \"root\" or an int.", "oneOf":[ { "type":"string" }, { "type":"integer" } ], "example":"1" }, "Filters":{ "description":"Array of filters belonging to the filter group.", "type":"array", "items":{ "type":"object", "properties":{ "FilterID":{ "description":"Filter ID", "type":"integer", "example":"1" }, "FilterName":{ "description":"Filter Name", "type":"string", "example":"All Events" } } }, "example":[ { "FilterID":"1", "FilterName":"All Events" }, { "FilterID":"2", "FilterName":"Syslogs" } ] } } }, "eventFilterGroups":{ "type":"object", "properties":{ "FilterGroupName":{ "description":"The event filter group name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Global" }, "ParentFilterGroupID":{ "$ref":"#/components/schemas/eventFilterGroupsReadByID/properties/ParentFilterGroupID" }, "OwnerUserID":{ "$ref":"#/components/schemas/eventFilterGroupsReadByID/properties/OwnerUserID" }, "OwnerUserGroupID":{ "$ref":"#/components/schemas/eventFilterGroupsReadByID/properties/OwnerUserGroupID" }, "RestrictionFilter":{ "$ref":"#/components/schemas/eventFilterGroupsReadByID/properties/RestrictionFilter" }, "Filters":{ "description":"List of Filters IDs", "type":"array", "items":{ "type":"integer" }, "example":[ 1, 2 ] }, "Remove":{ "description":"Whether to remove the filters from other event filter groups (1 for true) or not (0 for false).", "type":"boolean", "example":"1" } } }, "eventFilterGroupsReadForSelect":{ "type":"object", "properties":{ "FilterGroupID":{ "description":"The filter group ID.", "type":"integer", "example":"3" }, "DisplayName":{ "description":"The name of the filter group.", "type":"integer", "example":"Global" }, "cls":{ "description":"Class for the UI decoration.", "type":"string", "example":"folder" }, "leaf":{ "description":"Flag to indicate if this is a filter (leaf=true) or filter group (leaf=false).", "type":"boolean", "example":false }, "text":{ "description":"Name of the filter group.", "type":"string", "example":"Global" } } }, "eventFilterGroupsUpdateMoveReqBody":{ "type":"object", "properties":{ "id":{ "description":"The comma-separated list of event filter group IDs.", "type":"integer", "example":"3" }, "ParentFilterGroupID":{ "$ref":"#/components/schemas/eventFilterGroupsReadByID/properties/ParentFilterGroupID" } } }, "eventFilterGroupsUpdateMove":{ "type":"object", "properties":{ "FilterGroupName":{ "$ref":"#/components/schemas/eventFilterGroupsReadByID/properties/FilterGroupName" }, "OwnerUserID":{ "$ref":"#/components/schemas/eventFilterGroupsReadByID/properties/OwnerUserID" }, "OwnerUserGroupID":{ "$ref":"#/components/schemas/eventFilterGroupsReadByID/properties/OwnerUserGroupID" }, "RestrictionFilter":{ "$ref":"#/components/schemas/eventFilterGroupsReadByID/properties/RestrictionFilter" }, "FilterGroupID":{ "$ref":"#/components/schemas/eventFilterGroupsReadByID/properties/FilterGroupID" }, "ParentFilterGroupID":{ "$ref":"#/components/schemas/eventFilterGroupsReadByID/properties/ParentFilterGroupID" }, "Filters":{ "$ref":"#/components/schemas/eventFilterGroupsReadByID/properties/Filters" } } }, "eventFilterGroupsReadForTreeIDResponse":{ "type":"object", "properties":{ "data":{ "description":"List of properties of the filter group from root to the given ID.", "type":"array", "items":{ "type":"object", "properties":{ "FilterGroupID":{ "description":"ID of the filter group.", "type":"integer", "example":"3" }, "FilterGroupName":{ "description":"Name of the filter group.", "type":"integer", "example":"Global" }, "leaf":{ "description":"Flag to indicate if this is a filter (leaf=1) or filter group (leaf=0).", "type":"integer", "example":0 }, "Lft":{ "description":"The mysql tree left boundary value.", "type":"integer", "example":"1" }, "Rgt":{ "description":"The mysql tree right boundary value.", "type":"integer", "example":"2" }, "path":{ "description":"The full path value.", "type":"string", "example":"/Global" }, "depth":{ "description":"The tree depth level.", "type":"integer", "example":"1" }, "expanded":{ "description":"Boolean value that tree node is expanded.", "type":"boolean", "example":true }, "data":{ "description":"List of children filter groups.", "type":"array", "items":{ "type":"object" }, "example":[ { "FilterGroupID":"3", "FilterGroupName":"Unused", "leaf":"0", "Lft":"4", "Rgt":"7", "path":"/Global/Unused", "depth":2 } ] } } } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"2" } } }, "eventFilterGroupsReadForTreeNodeResponse":{ "type":"object", "properties":{ "data":{ "description":"List of children list groups.", "type":"array", "items":{ "type":"object", "properties":{ "FilterGroupID":{ "description":"Child filter group ID.", "type":"integer", "example":"5" }, "FilterGroupName":{ "description":"Name of the child filter group.", "type":"string", "example":"Oracle" }, "leaf":{ "description":"Flag to indicate if this is a filter (leaf=true) or filter group (leaf=false).", "type":"boolean", "example":true }, "iconCls":{ "description":"CSS class for icons.", "type":"string", "example":"x-tree-icon-parent" } } } }, "total":{ "description":"The total number of results regardless of paging.", "type":"integer", "example":"2" } } }, "eventMechanizationsRead":{ "type":"object", "properties":{ "EventMechanizationID":{ "description":"The event mechanization ID.", "type":"integer", "example":"2" }, "EventMechanizationName":{ "description":"Mechanization Name", "type":"string", "example":"CorrelateProblemResolutions" }, "Description":{ "description":"Mechanization Description", "type":"string", "example":"Update all matching problems and resolutions to normal severity and set expiration to 10 minutes" }, "Minutes":{ "description":"Scheduled Job cron-type Minutes to execute (* or comma delimited ints)", "type":"string", "example":"0,5,10,15,20,25,30,35,40,45,50,55" }, "Hours":{ "description":"Scheduled Job cron-type Hours to execute (* or comma delimited ints)", "type":"string", "example":"*" }, "Days":{ "description":"Scheduled Job cron-type Days to execute (* or comma delimited ints)", "type":"string", "example":"*" }, "Months":{ "description":"Scheduled Job cron-type Months to execute (* or comma delimited ints)", "type":"string", "example":"*" }, "WeekDays":{ "description":"Scheduled Job cron-type WeekDays to execute (* or comma delimited ints)", "type":"string", "example":"*" }, "StatusID":{ "description":"The mechanization status ID. Either 0 (disabled) or 1 (enabled).", "type":"integer", "example":"1" }, "Status":{ "description":"Says if it is Enabled/Disabled", "type":"string", "example":"Enabled" }, "StatusIcon":{ "description":"Icon for the Status", "type":"string", "example":"OrbGreen.png" }, "StoredProcedure":{ "description":"Mechanization Logic", "type":"string" } } }, "eventMechanizations":{ "type":"object", "properties":{ "EventMechanizationName":{ "description":"The event mechanization name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"CorrelateProblemResolutions" }, "Description":{ "$ref":"#/components/schemas/eventMechanizationsRead/properties/Description" }, "StoredProcedure":{ "$ref":"#/components/schemas/eventMechanizationsRead/properties/StoredProcedure" }, "Minutes":{ "$ref":"#/components/schemas/eventMechanizationsRead/properties/Minutes" }, "Hours":{ "$ref":"#/components/schemas/eventMechanizationsRead/properties/Hours" }, "Days":{ "$ref":"#/components/schemas/eventMechanizationsRead/properties/Days" }, "Months":{ "$ref":"#/components/schemas/eventMechanizationsRead/properties/Months" }, "WeekDays":{ "$ref":"#/components/schemas/eventMechanizationsRead/properties/WeekDays" }, "StatusID":{ "$ref":"#/components/schemas/eventMechanizationsRead/properties/StatusID" } } }, "eventMechanizationsReadForSelect":{ "type":"object", "properties":{ "EventMechanizationID":{ "$ref":"#/components/schemas/eventMechanizationsRead/properties/EventMechanizationID" }, "EventMechanizationName":{ "$ref":"#/components/schemas/eventMechanizationsRead/properties/EventMechanizationName" } } }, "eventMenusRead":{ "type":"object", "properties":{ "MenuID":{ "description":"The event menu ID.", "type":"integer", "example":"1" }, "DisplayName":{ "description":"The event menu name.", "type":"string", "example":"Global" }, "ParentMenuID":{ "description":"Menu ID for the parent group.", "type":"integer", "example":"2" }, "cls":{ "description":"Class for the UI decoration.", "type":"string", "example":"folder" } } }, "eventMenusReadByID":{ "type":"object", "properties":{ "MenuName":{ "description":"Menu Name", "type":"string", "example":"Administrators" }, "MenuID":{ "description":"The event menu ID.", "type":"integer", "example":"2" }, "UserGroupID":{ "description":"The user group ID.", "type":"integer", "example":"1" }, "DefaultMenu":{ "description":"Flag to indicate if this is the default menu or not.", "type":"integer", "example":"0" }, "ParentMenuID":{ "description":"Parent Menu ID", "type":"integer", "example":"1" }, "Tools":{ "description":"List of Tool IDs", "type":"array", "items":{ "type":"object", "properties":{ "ToolID":{ "description":"Tool ID", "type":"integer", "example":"1" }, "ToolName":{ "description":"Tool Name", "type":"string", "example":"Acknowledge" } } }, "example":[ { "ToolID":"1", "ToolName":"Acknowledge" }, { "ToolID":"2", "ToolName":"UnAcknowledge" } ] } } }, "eventMenus":{ "type":"object", "properties":{ "MenuName":{ "description":"The event menu name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Admin" }, "ParentMenuID":{ "$ref":"#/components/schemas/eventMenusReadByID/properties/ParentMenuID" }, "DefaultMenu":{ "$ref":"#/components/schemas/eventMenusReadByID/properties/DefaultMenu" }, "UserGroupID":{ "$ref":"#/components/schemas/eventMenusReadByID/properties/UserGroupID" }, "Tools":{ "description":"List of Tool IDs", "type":"array", "items":{ "type":"integer" }, "example":[ 1, 2 ] } } }, "eventMenusUpdate":{ "type":"object", "properties":{ "MenuName":{ "$ref":"#/components/schemas/eventMenus/properties/MenuName" }, "DefaultMenu":{ "$ref":"#/components/schemas/eventMenusReadByID/properties/DefaultMenu" }, "UserGroupID":{ "$ref":"#/components/schemas/eventMenusReadByID/properties/UserGroupID" }, "Tools":{ "description":"List of Tool IDs", "type":"array", "items":{ "type":"integer" }, "example":[ 1, 2 ] } } }, "eventMenusReadForTree":{ "type":"object", "properties":{ "MenuID":{ "$ref":"#/components/schemas/eventMenusReadByID/properties/MenuID" }, "MenuName":{ "$ref":"#/components/schemas/eventMenusReadByID/properties/MenuName" }, "leaf":{ "description":"Flag to indicate if there is a submenu or not.", "type":"boolean", "example":false }, "iconCls":{ "description":"Class for the UI decoration.", "type":"string", "example":"x-tree-icon-parent" } }, "example":{ "MenuID":"1", "MenuName":"Global", "leaf":false, "iconCls":"x-tree-icon-parent" } }, "eventMenusReadForMenu":{ "type":"object", "properties":{ "realtime":{ "type":"object", "properties":{ "MenuID":{ "description":"The event menu ID.", "type":"integer", "example":"4" }, "MenuName":{ "description":"Menu Name", "type":"string", "example":"Search KB" }, "text":{ "description":"Menu name.", "type":"string", "example":"Search KB" }, "UserGroupID":{ "description":"User Group ID", "type":"integer", "example":"1" }, "DefaultMenu":{ "description":"Flag to indicate if this is the default menu or not.", "type":"integer", "example":"0" }, "ParentMenuID":{ "description":"Parent Menu ID", "type":"integer", "example":"2" }, "UserGroupName":{ "description":"User Group name", "type":"string", "example":"Administrators" }, "menu":{ "type":"array", "items":{ "type":"object", "properties":{ "ToolID":{ "description":"Menu tool ID.", "type":"integer", "example":"20" }, "text":{ "description":"Tool Name.", "type":"string", "example":"By Device" }, "ToolName":{ "description":"Tool Name.", "type":"string", "example":"By Device" }, "ToolTypeName":{ "description":"The tool type can be either \"View\" or \"SQL\".", "type":"string", "example":"View" }, "icon":{ "description":"Path to the icon image to use in the menu.", "type":"string", "example":"/resources/assure1/images/icons/misc/BookSearch.png" }, "ToolPath":{ "description":"Path to launch the view tool. SQL tools do not have a path.", "type":"string", "example":"Knowledgebase.php?Action=Search;Type=Device;EventID=" }, "ToolPathTypeName":{ "description":"Indicator for what type of view tool this is.\nAllowed values are local, hybrid, internal, remote.", "type":"string", "example":"Local" }, "ContextID":{ "example":"1" }, "AugmentData":{ "description":"Flag to indicate if the event information is available to the tool.", "type":"integer", "example":"1" }, "Refresh":{ "description":"Flag to indicate if the event list will be unpaused and refreshed when the tool finishes.", "type":"integer", "example":"0" }, "ToolTarget":{ "description":"How to handle the tool contents. Allowed values are newtab, window, or currenttab. Newtab opens the tool in a new browser tab. Currenttab opens the tool in the current tab. Window opens the tool in a new browser window.", "type":"string", "example":"window" }, "Height":{ "description":"Tool window height in pixels.", "type":"integer", "example":"600" }, "Width":{ "description":"Tool window width in pixels.", "type":"integer", "example":"800" } } } } } } } }, "eventMenusUpdateMove":{ "type":"object", "properties":{ "id":{ "description":"The ID of the menu to move.", "type":"integer", "example":"2" }, "MenuName":{ "$ref":"#/components/schemas/eventMenusReadByID/properties/MenuName" }, "ParentMenuID":{ "$ref":"#/components/schemas/eventMenusReadByID/properties/ParentMenuID" } } }, "eventMetaEventsRead":{ "type":"object", "properties":{ "MetaEventID":{ "description":"Meta Event ID specified for individual CRUD operations for Assure1.EventMetaEvents", "type":"integer", "example":"1" }, "MetaEventName":{ "description":"Meta Event Name", "type":"string", "example":"Default Service Event" }, "MetaEventDescription":{ "description":"Description of Meta Event", "type":"string", "example":"Default Service Event" }, "Ack":{ "description":"Indicates if the event has been flagged as acknowledged. Events will be displayed differently based on Ack.\n- 0 -> N0\n- 1 -> Yes", "type":"integer", "example":"0" }, "Action":{ "description":"Action is an indication for a non-human entity that caused a change to be made.", "type":"string", "example":"$ACTION" }, "Actor":{ "description":"Actor is an indication of the entity that caused the change to be made.", "type":"string", "example":"$ACTOR" }, "Count":{ "description":"The number of times this Event has happened (deduplicated)", "type":"integer", "example":"1" }, "Department":{ "description":"Customer.rules will set this to Unknown if not previously set.", "type":"string", "example":"" }, "Details":{ "description":"Details of the event (a JSON text)", "type":"string", "example":"{}" }, "DeviceType":{ "description":"Device Type is used as a general category for the event. Customer.rules will set this to Unknown if not previously set.", "type":"string", "example":"Service" }, "DstIP":{ "type":"string", "example":"" }, "DstPort":{ "type":"string", "example":"" }, "EscalationFlag":{ "description":"If an event should be escalated or not. \n??? 0 = no\n??? 1 = should be escalated\n??? 2 = has been escalated", "type":"integer", "example":"" }, "EscId":{ "type":"integer", "example":"" }, "EventCategory":{ "description":"Event Category\n- 1 -> Resolution\n- 2 -> Problem\n- 3 -> Discrete", "type":"string", "example":"$STATE" }, "EventKey":{ "description":"Event Key", "type":"string", "example":"Service_$SERVICENAME" }, "EventType":{ "description":"Event type.", "type":"string", "example":"Event SLM" }, "ExpireTime":{ "description":"Time at which the event expired (Number of seconds after LastChanged for this Event to become eligible-to-be-deleted, which is done by the mechanization DeleteExpired)", "type":"integer", "example":"3600" }, "FirstReported":{ "description":"Timestamp when event was first reported", "type":"string", "example":"$TIMESTAMP" }, "IPAddress":{ "type":"string", "example":"$IPADDRESS" }, "LastChanged":{ "description":"Timestamp when event was last changed", "type":"string", "example":"$TIMESTAMP" }, "LastReported":{ "description":"Timestamp when event was last reported", "type":"string", "example":"$TIMESTAMP" }, "Location":{ "description":"Name, Address, or something similar associated with the Event. Observability Analytics uses this if it is set.", "type":"string", "example":"" }, "Method":{ "description":"Protocol of how the event was received/retrieved. The binary will set a default value (Trapd, Syslogd, for example), but can be update in rules, if needed.", "type":"string", "example":"EventSLM" }, "Node":{ "description":"The name of the device where the event happened (usually the DNS name of the device associated with the event)", "type":"string", "example":"$SERVICENAME" }, "OrigSeverity":{ "description":"The original severity when the event was first created.", "type":"string", "example":"$SEVERITY" }, "Score":{ "description":"If a Priority value is set on a device, this field can be set to the event Severity * Priority to increase the number. Event Filters can be configured to show the hi-score Events first, or other processing may utilize this value.", "type":"string", "example":"" }, "Service":{ "description":"The SLM applications will set this to the name of the SLM Service if a violation is detected.", "type":"string", "example":"$SERVICENAME" }, "ServiceImpact":{ "description":"Flag to indicate a provided service has been impacted. \n\nAllowed values: \n- 0 = Not service impacting \n- 1 = Service impacting", "type":"string", "example":"$SERVICEIMPACT" }, "Severity":{ "description":"Must be a value between 0 - 5. The event will change colors in the Event List based on the severity.\n\nAllowed Values:\n- 0 => Normal\n- 1 => Unknown\n- 2 => Info\n- 3 => Minor\n- 4 => Major\n- 5 => Critical", "type":"string", "example":"$SEVERITY" }, "SrcIP":{ "type":"string", "example":"" }, "SrcPort":{ "type":"string", "example":"" }, "SubDeviceType":{ "description":"Used for vendor or model information for the event. Customer.rules will set this to Unknown if not previously set.", "type":"string", "example":"Event Service" }, "SubMethod":{ "description":"Usually set in rules to the specific processing that was done on the event, for example, the MIB that defines the trap, or the string \"watchdog\", or \"Unknown\".", "type":"string", "example":"$SERVICENAME" }, "SubNode":{ "description":"The Instance of the Event, for example, the ifIndex value of a linkUp trap. Mechanization CorrelateProblemResolutions requires that this is the same for correlating events", "type":"string", "example":"$SERVICEID" }, "Summary":{ "description":"Event description summary.", "type":"string", "example":"Service $STATE_TEXT ($VALUE $OPERATOR $THRESHOLD)" }, "TicketFlag":{ "description":"A flag for the ticket state of this event. \n- 0 = no ticket\n- 1 = ticket to be created\n- 2 = processing\n- 3 = opened", "type":"string", "example":"" }, "TicketID":{ "description":"The Ticket ID associated with this Event in the external system. Should be populated by the process done to open the ticket in the external system.", "type":"integer", "example":"" }, "ZoneID":{ "description":"Can be set to the Device Zone that the device is in.", "type":"integer", "example":"" } } }, "eventMetaEvents":{ "type":"object", "properties":{ "MetaEventName":{ "description":"The meta event name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Default Service Event" }, "MetaEventDescription":{ "$ref":"#/components/schemas/eventMetaEventsRead/properties/MetaEventDescription" } } }, "eventMetaEventsReadForSelect":{ "type":"object", "properties":{ "MetaEventID":{ "$ref":"#/components/schemas/eventMetaEventsRead/properties/MetaEventID" }, "MetaEventName":{ "$ref":"#/components/schemas/eventMetaEventsRead/properties/MetaEventName" } } }, "eventNodesRead":{ "type":"object", "properties":{ "NodeID":{ "description":"Node ID specified for individual CRUD operations", "type":"integer", "example":"1" }, "NodeName":{ "description":"CAPE Node Name", "type":"string", "example":"EscalateByAnomaly" }, "NodeAlias":{ "description":"CAPE Node Alias (optional) used for referencing another CAPE node", "type":"string", "example":null, "nullable":true }, "NodeDescription":{ "description":"CAPE Node Description", "type":"string", "example":"Take anomaly event by Machine Learning Policy and escalated Severity" }, "NodeActionText":{ "description":"Content of CAPE Node Rule", "type":"string", "example":"use JSON;\n\nmy $EventDBH = DBConnect($Config, 'Event', {AutoCommit => 1});\n\nmy $CurrentTime = sprintf \"%.3f\", Time::HiRes::time;\n\n# Get Anomaly EventID and Details\nmy $AnomalyEventID = $EventData->{EventID};\nmy $AnomalyDetails;\n\neval {\n\tlocal $SIG{__DIE__};\n\n\t$AnomalyDetails = decode_json($EventData->{Details});\n};\nif ($@) {\n $Log->Message(\"ERROR\", \"Failed to decode Details: $@\");\n}\n\n# Get ML job\nmy $AnomalyJobID = $AnomalyDetails->{MLJobID};\n\n# Get Filter | Node ='xyz' AND SubNode='eth0'\nmy $AnomalyFilter = $AnomalyDetails->{EventFilter};\n\nmy $AnomalyDuration = $CurrentTime - $EventData->{FirstReported};\n\n# Mark Anomaly Event to prevent duplicate processing\nmy ($ErrorFlag, $Message) = UpdateEvent({\n\tDBH => \\$EventDBH,\n\tEventID => $AnomalyEventID,\n\tValues => {\n\t\tAction => 'EscalateByAnomaly',\n\t\tActor => 'CAPE',\n\t\tDuration => $AnomalyDuration,\n\t\tLastChanged => $CurrentTime,\n\t\tRootCauseFlag => 1,\n\t\tSeverity => 0\n\t}\n});\n\n$Log->Message(\"WARN\", \"-> EscalateByAnomaly -> Marked Anomaly Event [$AnomalyEventID] as Cleared\");\n\n$Log->Message(\"WARN\", \"-> EscalateByAnomaly -> Escalating filter [$AnomalyFilter]\");\n\n# Retrieve alarms in filter with timeframe\nmy ($ErrorFlag1, $Message1, $EventRef) = FindEventID({\n\tDBH => \\$EventDBH,\n\tFilter => $AnomalyFilter\n});\n\nmy $EventList = join(',', @$EventRef);\n\n$Log->Message(\"WARN\", \"-> EscalateByAnomaly -> Escalating filter returns [$EventList]\");\n\n# Set Severity Setting\nmy $SymptomNewSeverity = 5;\n\nmy $i = 0;\nforeach my $SymptomEventID (@$EventRef) {\n\t$i++;\n\n\t# Get symptom\n\tmy $SymptomEvent = GetEventHash({\n\t\tDBH => \\$EventDBH,\n\t\tEventID => $SymptomEventID,\n\t\tShardID => 1\n\t});\n\n\tmy $SymptomOrigSeverity = $SymptomEvent->{Severity};\n\tmy $SymptomDuration = $CurrentTime - $SymptomEvent->{FirstReported};\n\n\t# Suppress Events\n\tmy ($ErrorFlag, $Message) = UpdateEvent({\n\t\tDBH => \\$EventDBH,\n\t\tEventID => $SymptomEventID,\n\t\tValues => {\n\t\t\tAction => 'EscalateByAnomaly',\n\t\t\tActor => 'CAPE',\n\t\t\tDuration => $SymptomDuration,\n\t\t\tLastChanged => $CurrentTime,\n\t\t\tOrigSeverity => $SymptomOrigSeverity,\n\t\t\tRootCauseID => $AnomalyEventID,\n\t\t\tSeverity => $SymptomNewSeverity\n\t\t}\n\t});\n\n\t# EventJournal for suppression\n\tmy ($ErrorFlag, $Message) = AddJournal({\n\t\tDBH => \\$EventDBH,\n\t\tEventID => $SymptomEventID,\n\t\tTimeStamp => $CurrentTime,\n\t\tUsername => 'api',\n\t\tEntry => 'Escalate Abnormal Activity via event [' . $AnomalyEventID . '] due to [' . $AnomalyJobID . ']'\n\t});\n}\n\n$EventDBH->disconnect();" }, "NodeStateVerify":{ "description":"CAPE Node \"next node\" test statement. If this evaluates to \"true\", the event will be passed to $NodeNextNode", "type":"string", "example":"" }, "NodeAliasDisplay":{ "description":"UI-Only field that is either the NodeAlias if one exists or \"[None]\" if no alias is set", "type":"string", "example":"[None]" }, "NodeNextNodeName":{ "description":"NodeName of the next node IF a node is set as the next to be executed", "type":"string", "example":null, "nullable":true }, "NodeNextNodeID":{ "description":"NodeID of the next node IF a node is set as the next to be executed.", "type":"integer", "example":null, "nullable":true } } }, "eventNodes":{ "type":"object", "properties":{ "NodeActionText":{ "$ref":"#/components/schemas/eventNodesRead/properties/NodeActionText" }, "NodeAlias":{ "$ref":"#/components/schemas/eventNodesRead/properties/NodeAlias" }, "NodeDescription":{ "$ref":"#/components/schemas/eventNodesRead/properties/NodeDescription" }, "NodeName":{ "description":"The CAPE node name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"EscalateByAnomaly" }, "NodeNextNode":{ "$ref":"#/components/schemas/eventNodesRead/properties/NodeNextNodeID" }, "NodeStateVerify":{ "$ref":"#/components/schemas/eventNodesRead/properties/NodeStateVerify" } } }, "eventNodesReadForSelect":{ "type":"object", "properties":{ "NodeID":{ "$ref":"#/components/schemas/eventNodesRead/properties/NodeID" }, "NodeName":{ "$ref":"#/components/schemas/eventNodesRead/properties/NodeName" } } }, "eventPoliciesRead":{ "type":"object", "properties":{ "PolicyID":{ "description":"Profile ID specified for individual CRUD operations", "type":"integer", "example":"1" }, "PolicyStatusIcon":{ "description":"CAPE Policy Status Icon. The icon will be \"OrbRed.png\" or \"OrbGreen.png\"", "type":"string", "example":"OrbGreen.png" }, "PolicyStatus":{ "description":"Status for the Policy. Status will be Enabled or Disabled.", "type":"string", "example":"Enabled" }, "PolicyName":{ "description":"CAPE Policy Name", "type":"string", "example":"AbnormalActivity" }, "PolicyStatusID":{ "description":"The policy status ID. Either 0 (disabled) or 1 (enabled).", "type":"integer", "example":"1" }, "PolicyDescription":{ "description":"CAPE Policy Description", "type":"string", "example":"Analytics has found an event that has never happened before or through heuristics has been found as not noise but important. The goal is to increase the severity of the originating event." }, "PolicySelectSQL":{ "description":"SQL used to select which events will be processed by this CAPE Policy's node(s)", "type":"string", "example":"SELECT *\n FROM Events\n WHERE Severity > 1\n AND EventType LIKE 'AbnormalActivity-%'\n" }, "PolicyProcessType":{ "description":"Flag to indicate whether events will be processed by each node in a batch, or individually\n\nAllowed Values:\n - 0 => Process Events Individually\n - 1 => Process Events Together", "type":"string", "example":"0" }, "PolicyPollTime":{ "description":"Interval, in seconds, this policy should run (30 seconds recommended minimum)", "type":"integer", "example":"30" }, "PolicyNodeID":{ "description":"The ID of the first node called to process this policy's matching events.", "type":"integer", "example":"1" }, "PolicyNodeName":{ "description":"Name of the first node called.", "type":"string", "example":"EscalateByAnomaly" }, "PolicyNodeNameDisplay":{ "description":"Name of the first node called.", "type":"string", "example":"EscalateByAnomaly" }, "PolicyZoneID":{ "description":"The device zone ID associated with the policy. 0 is used for \"all zones\".", "type":"integer", "example":"0" }, "PolicyZoneName":{ "description":"The device zone name associated with the policy. It will be null if the zone ID is 0.", "type":"string", "example":null }, "PolicyZoneNameDisplay":{ "description":"The device zone name associated with the policy. It will be \"[All]\" if the zone ID is 0.", "type":"string", "example":"[All]" } } }, "eventPolicies":{ "type":"object", "properties":{ "PolicyName":{ "description":"The CAPE policy name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Abnormal Activity" }, "PolicyDescription":{ "$ref":"#/components/schemas/eventPoliciesRead/properties/PolicyDescription" }, "PolicyNodeID":{ "$ref":"#/components/schemas/eventPoliciesRead/properties/PolicyNodeID" }, "PolicyPollTime":{ "$ref":"#/components/schemas/eventPoliciesRead/properties/PolicyPollTime" }, "PolicyProcessType":{ "$ref":"#/components/schemas/eventPoliciesRead/properties/PolicyProcessType" }, "PolicySelectSQL":{ "$ref":"#/components/schemas/eventPoliciesRead/properties/PolicySelectSQL" }, "PolicyStatusID":{ "$ref":"#/components/schemas/eventPoliciesRead/properties/PolicyStatusID" }, "PolicyZoneID":{ "$ref":"#/components/schemas/eventPoliciesRead/properties/PolicyZoneID" } } }, "eventPoliciesReadForSelect":{ "type":"object", "properties":{ "PolicyID":{ "$ref":"#/components/schemas/eventPoliciesRead/properties/PolicyID" }, "PolicyName":{ "$ref":"#/components/schemas/eventPoliciesRead/properties/PolicyName" } } }, "eventSupervisedCorrelationsRead":{ "type":"object", "properties":{ "SupervisedCorrelationID":{ "description":"Event to be modified as either the root cause or correlated to another event", "type":"integer", "example":"1037" }, "SupervisedCorrelationName":{ "description":"Name of the supervised correlation policy", "type":"string", "example":"test name" }, "GroupByFields":{ "description":"The event field or fields to group by", "type":"string", "example":"Ack" }, "MinimumMembers":{ "description":"Minimum number of events to establish an event cluster based on the correlation policy definition", "type":"integer", "example":"1" }, "TimeWindow":{ "description":"Length of the time window for the correlation policy, in seconds", "type":"integer", "example":"30" }, "MetaEventID":{ "description":"Meta event to create as the root cause", "oneOf":[ { "type":"string" }, { "type":"integer" } ], "example":"1" }, "RootCause":{ "description":"Root Cause", "type":"integer", "example":"1" }, "StatusID":{ "description":"The supervised correlation status ID. Either 0 (disabled) or 1 (enabled).", "type":"integer", "example":"1" }, "Status":{ "description":"Current Status", "type":"string", "example":"Enabled" }, "RootFlags":{ "description":"Root flags", "type":"integer", "example":"0" }, "MatchFields":{ "description":"The event fields that must have matching values to fit the cluster", "oneOf":[ { "type":"array" }, { "type":"string" } ], "example":"SubNode" }, "MatchFieldValues":{ "description":"The values of the match fields", "oneOf":[ { "type":"array" }, { "type":"string" } ], "example":"test" } } }, "eventSupervisedCorrelations":{ "type":"object", "properties":{ "SupervisedCorrelationName":{ "description":"The supervised correlation name.\n
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"SC Name" }, "MatchFields":{ "$ref":"#/components/schemas/eventSupervisedCorrelationsRead/properties/MatchFields" }, "MetaEventID":{ "$ref":"#/components/schemas/eventSupervisedCorrelationsRead/properties/MetaEventID" }, "GroupByFields":{ "$ref":"#/components/schemas/eventSupervisedCorrelationsRead/properties/GroupByFields" }, "MinimumMembers":{ "$ref":"#/components/schemas/eventSupervisedCorrelationsRead/properties/MinimumMembers" }, "TimeWindow":{ "$ref":"#/components/schemas/eventSupervisedCorrelationsRead/properties/TimeWindow" }, "StatusID":{ "$ref":"#/components/schemas/eventSupervisedCorrelationsRead/properties/StatusID" } } }, "eventToolsRead":{ "type":"object", "properties":{ "ToolID":{ "description":"The event tool ID.", "type":"integer", "example":"1" }, "ToolName":{ "description":"The event tool name.", "type":"string", "example":"Acknowledge" }, "ToolTypeID":{ "description":"The ID of the event tool type. Allowed values:\n
  • 1: View
    • \n
  • 2: SQL
", "type":"integer", "example":"1" }, "ToolTypeName":{ "description":"The name of the event tool type. Allowed values:\n
  • View
    • \n
  • SQL
", "type":"string", "example":"View" }, "JournalStatusName":{ "description":"The text indication of whether a journal entry is added when the tool is run (Enabled) or not (Disabled).", "type":"string", "example":"Enabled" }, "JournalStatusIcon":{ "description":"The icon to indicate the journal status.", "type":"string", "example":"OrbGreen.png" }, "Icon":{ "description":"The icon to represent the tool.", "type":"string", "example":"fugue/thumb-up.png" }, "JournalStatus":{ "description":"The integer indication of whether an event journal entry will be added when tool is run (1) or not (0).", "type":"integer", "example":"1" }, "JournalText":{ "description":"The event journal entry that will be added when the tool is run.", "type":"string", "example":"Event Acknowledged" }, "ToolPath":{ "description":"The relative path to the URL that the tool opens. Only used for view tools.", "type":"string", "example":"/go/vision/index?filterText=<Details>", "nullable":true }, "ToolPathType":{ "description":"The tool path type. Only used for view tools.
Allowed values are: \n
  • Local
    • \n
  • Internal
    • \n
    • Hybrid
      • \n
    • Remote
    ", "type":"string", "example":"Remote", "nullable":true }, "AugmentData":{ "description":"Whether to obtain event data for the selected event (1) or not (0) to be used in the tool's request parameters. Only used for view tools.", "type":"boolean", "example":"1", "nullable":true }, "Refresh":{ "description":"Whether the event list should be unpaused and refreshed when the tool finishes (1) or not (0). Only used for view tools.\nWhen ToolTarget is set to newtab, the list refreshes when the tab opens.
    \nWhen ToolTarget is set to window, the list refreshes when the pop-up window is closed.
    \nWhen ToolTarget is set to currenttab, this setting does not apply.", "type":"integer", "example":"1", "nullable":true }, "Width":{ "description":"The width of the tool window, in pixels. Only used for view tools.", "type":"integer", "example":"80", "nullable":true }, "Height":{ "description":"The height of the tool window, in pixels. Only used for view tools.", "type":"integer", "example":"80", "nullable":true }, "ToolTarget":{ "description":"Where the tool opens new pages. Only used for view tools.
    Allowed values:\n
    • window: Opens in a pop-up window.
      • \n
    • currenttab: Opens in the current tab.
      • \n
    • newtab: Opens in a new tab.
    ", "type":"string", "example":"window", "nullable":true }, "ToolTargetDisplay":{ "description":"The display name to use for the ToolTarget setting. Only used for view tools.
    Allowed Values:\n
    • PopUp
      • \n
    • CurrentTab
      • \n
    • NewTab
    ", "type":"string", "example":"PopUp", "nullable":true }, "ToolPathTypeID":{ "description":"The tool path type ID. Only used for view tools.
    Allowed values: \n
    • 1: Local
      • \n
    • 2: Internal
      • \n
    • 3: Hybrid
      • \n
    • 4: Remote
    ", "type":"string", "example":null, "nullable":true }, "ToolSQL":{ "description":"The SQL command to run against the Event.Events schema table. Only used for SQL tools.", "type":"string", "example":"UPDATE Events SET Action = 'SQL Tool: Acknowledge', Actor = $USERNAME, LastChanged = UNIX_TIMESTAMP(NOW(3)), Ack = 1, OwnerName = $USERNAME WHERE Ack = 0 AND EventID IN ($EVENTLIST);" }, "JournalActor":{ "description":"The actor that will be used when adding an event journal when the event tool is run. If not specified, defaults to the user who ran the tool.", "type":"string", "example":"operator" }, "JournalAction":{ "description":"The action that will be used when adding an event journal when the event tool is run. If not specified, defaults to the name of the event tool.", "type":"string", "example":"Added by Event Tool" } } }, "eventTools":{ "type":"object", "properties":{ "ToolName":{ "description":"The event tool name.\n
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Acknowledge" }, "ToolTypeID":{ "$ref":"#/components/schemas/eventToolsRead/properties/ToolTypeID" }, "ToolPath":{ "description":"The relative path to the URL that the tool opens. Required for view tools only.
    \nYou can use tokens in the path that will be replaced with data from the selected event when the tool is run. The tokens are in the format <Field> or, for fields using display conversions, <FieldRaw>. \n
    For example, if you have a display conversion for ZoneID, use <ZoneIDRaw> for the token.
    If you later disable the conversion, you do not have to update the tool path again. The path will still work with the Raw field name, even when the conversion is disabled. If you delete the conversion, you must update the path to remove Raw. See the api/event/displayConversions endpoints for more information about creating display conversions.
    \nYou can use the following additional tokens:\n
    • <EventID>: The first selected event's EventID.
      • \n
    • <Events>: A comma-delimited list of all selected EventIDs.
      • \n
    • <ShardID>: The first selected event's ShardID.
      • \n
    • <Shards>: A comma-delimited list of all selected events' ShardIDs.
    ", "type":"string", "example":"/go/vision/index?filterText=<Details>", "nullable":true }, "ToolPathTypeID":{ "description":"The tool path type ID. Only used for view tools.
    Allowed values: \n
    • 1: Local
      • \n
    • 2: Internal
      • \n
    • 3: Hybrid
      • \n
    • 4: Remote
    ", "type":"integer", "example":null, "nullable":true }, "AugmentData":{ "description":"Whether to obtain event data for the selected event (1) or not (0) to be used in the tool's request parameters. Only used for view tools. Only used for view tools.", "type":"boolean", "example":"1", "nullable":true }, "Refresh":{ "description":"Whether the event list should be unpaused and refreshed when the tool finishes (1) or not (0). Only used for view tools.\nWhen ToolTarget is set to newtab, the list refreshes when the tab opens.
    \nWhen ToolTarget is set to window, the list refreshes when the pop-up window is closed.
    \nWhen ToolTarget is set to currenttab, this setting does not apply.", "type":"integer", "example":"1", "nullable":true }, "ToolTarget":{ "description":"Where the tool opens new pages. Only used for view tools.
    Allowed values:\n
    • window: Opens in a pop-up window.
      • \n
    • currenttab: Opens in the current tab.
      • \n
    • newtab: Opens in a new tab.
    ", "type":"string", "example":"window", "nullable":true }, "Width":{ "description":"The width of the tool window, in pixels. Only used for view tools.", "type":"integer", "example":"80", "nullable":true }, "Height":{ "description":"The height of the tool window, in pixels. Only used for view tools.", "type":"integer", "example":"80", "nullable":true }, "ToolSQL":{ "description":"The SQL command to run against the Event.Events schema table. Only used for SQL tools.", "type":"string", "example":"UPDATE Events SET Action = 'SQL Tool: Acknowledge', Actor = $USERNAME, LastChanged = UNIX_TIMESTAMP(NOW(3)), Ack = 1, OwnerName = $USERNAME WHERE Ack = 0 AND EventID IN ($EVENTLIST);" }, "Icon":{ "$ref":"#/components/schemas/eventToolsRead/properties/Icon" }, "JournalStatus":{ "description":"Whether to add an event journal entry when tool is run (1) or not (0).", "type":"integer", "example":"1" }, "JournalText":{ "description":"The event journal entry to add when the tool is run.", "type":"string", "example":"Event Acknowledged" }, "JournalActor":{ "description":"The actor to use when adding an event journal when the event tool is run. If not specified, defaults to the user who ran the tool.", "type":"string", "example":"Event Tool" }, "JournalAction":{ "description":"The action to use when adding an event journal when the event tool is run. If not specified, defaults to the name of the event tool.", "type":"string", "example":"Added by Event Tool" } } }, "eventWatcherPoliciesRead":{ "type":"object", "properties":{ "PolicyID":{ "description":"The policy ID specified for individual CRUD operations.", "type":"integer", "example":"2" }, "PolicyStatusIcon":{ "description":"Event Watcher Policy Status Icon", "type":"string", "example":"OrbRed.png" }, "PolicyStatus":{ "description":"Event Watcher Policy Status", "type":"string", "example":"Disabled" }, "PolicyName":{ "description":"Event Watcher Policy Name", "type":"string", "example":"Login Failure x3" }, "PolicyPollTime":{ "description":"How often, in seconds, should this policy be checked", "type":"integer", "example":"900" }, "PolicyThresholdMetric":{ "description":"SQL Function applied to $PolicyThresholdField and compared with the $PolicyThresholdOperatorID operator against $PolicyThresholdValue\n\nThe Threshold condition is formulated as 'if ($PolicyThresholdMetric($PolicyThresholdField) $PolicyThresholdOperatorID $PolicyThresholdValue)'\n\nAllowed Values:\n- count\n- sum\n- max\n- min\n- avg", "type":"string", "example":"sum" }, "PolicyThresholdField":{ "description":"Field from Event.Events DB table to use in threshold calculation. Value must be a field in Events.\n\nThe Threshold condition is formulated as 'if ($PolicyThresholdMetric($PolicyThresholdField) $PolicyThresholdOperatorID $PolicyThresholdValue)'", "type":"string", "example":"Count" }, "PolicyThresholdOperatorID":{ "description":"The OperatorID of the threshold calculation\n\nThe Threshold condition is formulated as 'if ($PolicyThresholdMetric($PolicyThresholdField) $PolicyThresholdOperatorID $PolicyThresholdValue)'\n\nAllowed Values:\n- 0 => =\n- 1 => >\n- 2 => >=\n- 3 => <\n- 4 => <=\n- 5 => !=", "type":"integer", "example":"2" }, "PolicyThresholdValue":{ "description":"The numeric value used in the threshold condition.\n\nThe Threshold condition is formulated as 'if ($PolicyThresholdMetric($PolicyThresholdField) $PolicyThresholdOperatorID $PolicyThresholdValue)'", "type":"number", "example":"3" }, "PolicyAuthor":{ "description":"Policy Author", "type":"string", "example":"Administrator" }, "PolicyStatusID":{ "description":"The event watcher policy status ID. Either 0 (disabled) or 1 (enabled).", "type":"integer", "example":"0" }, "PolicyDescription":{ "description":"Event Watcher Policy Description", "type":"string", "example":"For any Login Failures by Node in the last 15 mins\r\n\r\nIf any login failures occur and the Sum of Count >= 3, create this event." }, "PolicyFilter":{ "description":"SQL used to select which events will be processed by this CAPE Policy's node(s)", "type":"string", "example":"(EventType = 'LoginLogout' AND Severity > 1 AND LastReported > (UNIX_TIMESTAMP() - 900))" }, "PolicyGrouping":{ "description":"A SQL \"GROUP BY\" clause that allows the filtered metrics to be grouped. Valid format is empty or a comma-delimited list of one or more Event.Events field names", "type":"string", "example":"Node" }, "PolicyEventID":{ "description":"The ID of the Meta Event that should be dispatched if the threshold condition is met for the filtered metrics", "type":"integer", "example":"3" }, "PolicyEventName":{ "description":"The Name of the Meta Event that should be dispatched if the threshold condition is met for the filtered metrics", "type":"string", "example":"Login Failure x3" }, "NotificationProfileID":{ "description":"ID of the notification profile.", "type":"integer", "example":"0" }, "NotificationTemplateID":{ "description":"ID of the notification template.", "type":"integer", "example":"0" }, "EmailAddresses":{ "description":"Comma-separated list of notification recipients.", "type":"string", "example":"" }, "NotificationProfileName":{ "description":"Notification Profile Name", "type":"string", "example":null }, "NotificationTemplateName":{ "description":"Notification Template Name", "type":"string", "example":null }, "ActionType":{ "description":"Indicates which type of action to take when a threshold is crossed.\n\n- event => Meta Event\n- notification => Notification profile", "type":"string", "example":"event" }, "SearchType":{ "description":"Indicates which type of search\n\n- field => Guided\n- sql => Manual SQL", "type":"string", "example":"sql" }, "PolicyAction":{ "description":"Action associated with the Policy", "type":"string", "example":"Meta Event: Login Failure x3" }, "Filters":{ "description":"List of Filters with the Watcher", "type":"array", "items":{ "type":"object", "properties":{ "FieldName":{ "example":"Ack" }, "Expression":{ "example":"0" }, "FieldValue":{ "example":"" } } }, "example":[ { "FieldName":"Ack", "Expression":"0", "FieldValue":"" }, { "FieldName":"Action", "Expression":"0", "FieldValue":"" }, { "FieldName":"Actor", "Expression":"0", "FieldValue":"" } ] }, "PolicyThreshold":{ "description":"Overall threshold operation", "type":"string", "example":"sum(Count) >= 3" } } }, "eventWatcherPolicies":{ "type":"object", "properties":{ "PolicyName":{ "description":"The event watcher policy name.
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Login failure x3" }, "PolicyStatusID":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead/properties/PolicyStatusID" }, "PolicyPollTime":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead/properties/PolicyPollTime" }, "PolicyDescription":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead/properties/PolicyDescription" }, "PolicyGrouping":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead/properties/PolicyGrouping" }, "PolicyFilter":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead/properties/PolicyFilter" }, "PolicyThresholdMetric":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead/properties/PolicyThresholdMetric" }, "PolicyThresholdField":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead/properties/PolicyThresholdField" }, "PolicyThresholdOperatorID":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead/properties/PolicyThresholdOperatorID" }, "PolicyThresholdValue":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead/properties/PolicyThresholdValue" }, "PolicyEventID":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead/properties/PolicyEventID" }, "NotificationTemplateID":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead/properties/NotificationTemplateID" }, "NotificationProfileID":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead/properties/NotificationProfileID" }, "EmailAddresses":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead/properties/EmailAddresses" } } }, "eventWatcherPoliciesUpdate":{ "type":"object", "properties":{ "PolicyName":{ "$ref":"#/components/schemas/eventWatcherPolicies/properties/PolicyName" }, "PolicyStatusID":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead/properties/PolicyStatusID" }, "PolicyPollTime":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead/properties/PolicyPollTime" }, "PolicyDescription":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead/properties/PolicyDescription" }, "PolicyGrouping":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead/properties/PolicyGrouping" }, "PolicyFilter":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead/properties/PolicyFilter" }, "PolicyThresholdMetric":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead/properties/PolicyThresholdMetric" }, "PolicyThresholdField":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead/properties/PolicyThresholdField" }, "PolicyThresholdOperatorID":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead/properties/PolicyThresholdOperatorID" }, "PolicyThresholdValue":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead/properties/PolicyThresholdValue" }, "PolicyEventID":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead/properties/PolicyEventID" }, "NotificationTemplateID":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead/properties/NotificationTemplateID" }, "NotificationProfileID":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead/properties/NotificationProfileID" }, "ActionType":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead/properties/ActionType" }, "SearchType":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead/properties/SearchType" }, "EmailAddresses":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead/properties/EmailAddresses" } } }, "eventWatcherPoliciesReadForSelect":{ "type":"object", "properties":{ "PolicyID":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead/properties/PolicyID" }, "PolicyName":{ "$ref":"#/components/schemas/eventWatcherPoliciesRead/properties/PolicyName" } } }, "eventWatcherPoliciesReadFieldsForSelect":{ "type":"object", "properties":{ "FieldName":{ "type":"string", "example":"EventID" }, "FieldDescription":{ "type":"string", "example":"EventID - bigint unsigned" } }, "example":[ { "FieldName":"EventID", "FieldDescription":"EventID - bigint unsigned" }, { "FieldName":"EventKey", "FieldDescription":"EventKey - varchar(255)" } ] }, "fileFilesRead":{ "type":"object", "properties":{ "MimeType":{ "description":"The MIME type of the file.", "type":"string", "example":"image/png" }, "FileID":{ "description":"Unique identifier for the file.", "type":"integer", "example":"1000" }, "FileName":{ "description":"Name of the uploaded file, determined from Content-Disposition filename.", "type":"string", "example":"AccessPoint.png" }, "OwnerUserID":{ "description":"The ID of the user that owns the file. This can never be an externally-authenticated transient user. 0 means it is public to all users in the owning group.", "type":"integer", "example":"0" }, "OwnerUserGroupID":{ "description":"The user group owner of the file.", "type":"integer", "example":"1" }, "FileTypeID":{ "description":"The ID of the file type. The following default integer values are mapped to a string in the FileType property: \n
      \n
    • 1: Other
      • \n
    • 2: Image
      • \n
    • 3: Report
      • \n
    • 4: Sound
      • \n
    \nAny additional custom file types are mapped to values 1000 and up.
    This may, but does not have to, match the type indicated by the file's extension.", "type":"integer", "example":"2" }, "FileType":{ "description":"The type of the file.", "type":"string", "example":"Image" }, "ExpireTime":{ "description":"Expire time of file. Can be used to create a cleanup policy of expired files.", "type":"string", "example":"Never", "enum":[ "Never", "2023-02-28 05:02:00" ] }, "ExpireTimeFormatted":{ "description":"Expire Time after formatting", "type":"string", "example":"Never", "enum":[ "Never", "28 Feb 2023 05:02:00" ] }, "Expired":{ "description":"If file is expired or not. If the value is 1, then the file expiration time has exceeded.", "type":"integer", "example":"0" }, "Owner":{ "description":"Owner for the file.", "type":"string", "example":"Group: Administrators" }, "Viewers":{ "description":"Selection of user groups that have read-only access to file.", "type":"array", "items":{ "type":"object", "properties":{ "UserGroupID":{ "description":"User Group ID", "type":"integer" }, "UserGroupName":{ "description":"User Group Name", "type":"string" } } }, "example":[ { "UserGroupID":"0", "UserGroupName":"[Public to All Groups]" } ] }, "FileExtension":{ "description":"Type of extension for the file.", "type":"string", "example":"png" } } }, "fileFiles":{ "type":"object", "properties":{ "FileTypeID":{ "description":"The ID of the file type. The following default integer values will be mapped to a string in the FileType property automatically: \n
    • 1: Other
      • \n
    • 2: Image
      • \n
    • 3: Report
      • \n
    • 4: Sound
      • \n
    \nAny additional custom file types are mapped to values 1000 and up.
    This should, but does not have to, match the type indicated by the file's extension.", "type":"integer", "example":"2" }, "MimeType":{ "description":"The MIME type of the file. If you specify this parameter, it is used as specified, even if it does not match the type indicated by the file's extension. If you do not specify this property, it will be automatically detected based on the file's extension.", "type":"string", "example":"image/png" }, "ExpireTime":{ "description":"Expire time of file. Can be used to create a cleanup policy of expired files. It should be of format \"yyyy-mm-dd hh:mm:ss\" or \"Never\".", "type":"string", "enum":[ "Never", "2023-02-28 05:02:00" ], "example":"Never" }, "OwnerUserID":{ "$ref":"#/components/schemas/fileFilesRead/properties/OwnerUserID" }, "OwnerUserGroupID":{ "$ref":"#/components/schemas/fileFilesRead/properties/OwnerUserGroupID" }, "UploadFile":{ "description":"Upload File contents. Filename is determined from Content-Disposition filename. Fake upload (add file already on server), by populating with $_FILES fields." }, "Viewers":{ "$ref":"#/components/schemas/fileFilesRead/properties/Viewers" } } }, "fileFilesReadForSelect":{ "type":"object", "properties":{ "FileID":{ "$ref":"#/components/schemas/fileFilesRead/properties/FileID" }, "FileName":{ "$ref":"#/components/schemas/fileFilesRead/properties/FileName" }, "FileTypeID":{ "$ref":"#/components/schemas/fileFilesRead/properties/FileTypeID" } } }, "fileFileTypesRead":{ "type":"object", "properties":{ "FileTypeID":{ "description":"File Type ID specified for individual CRUD operations.", "type":"integer", "example":"2" }, "FileTypeName":{ "description":"File Type Name.", "type":"string", "example":"Image" } } }, "fileFileTypes":{ "type":"object", "properties":{ "FileTypeName":{ "description":"The file type name.\n
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Image" } } }, "gatewayGatewaysRead":{ "properties":{ "GatewayID":{ "description":"Unique identifier for the gateway.", "type":"string", "example":"a433d205-4cae-45c3-a637-50b08840ea63" }, "GatewayName":{ "description":"The name of the gateway, which must be unique within the database.", "type":"string", "example":"Gateway1" }, "Description":{ "description":"Description of the Gateway.", "type":"string", "example":"" }, "Port":{ "description":"Connection port.", "type":"integer", "example":9001 }, "Delimiter":{ "description":"The message delimiter used by the gateway.", "type":"string", "example":";" }, "DeviceID":{ "description":"Unique identifier associated with the device name.", "type":"integer", "example":54 }, "DeviceName":{ "description":"The Device Catalog entry associated to the Gateway, which is used for connection information.", "type":"string", "example":"router.example.com" }, "ConnectionTypeID":{ "description":"Connection Type\n0 => TCP Socket\n1 => Telnet login\n2 => SSH login", "type":"integer", "example":0 }, "ConnectionType":{ "description":"Gateway Connection Type. Plain TCP Socket, SSH login or Telnet login.", "type":"string", "example":"TCP socket" }, "NoPromptCheck":{ "description":"If Connection Type is set to \"SSH Login\" or \"Telnet Login\" and the TL1 device does not return a prompt on successful login, check this box.", "type":"boolean", "example":false }, "StatusID":{ "description":"The gateway status ID. Either 0 (disabled) or 1 (enabled).", "type":"integer", "example":1 }, "StatusName":{ "description":"The status of the gateway.", "type":"string", "example":"Enabled" }, "Username":{ "description":"If Connection Type is set to \"SSH Login\" or \"Telnet Login\", the username to use when connecting to Gateway.", "type":"string", "example":"admin" }, "Password":{ "description":"If Connection Type is set to \"SSH Login\" or \"Telnet Login\", the password to use when connecting to Gateway.", "type":"string", "example":"admin" }, "ElementCount":{ "description":"Count of the Gateway Element.", "type":"integer", "example":1 }, "Elements":{ "description":"Selection of associated Network Elements for this gateway.", "type":"array", "items":{ "properties":{ "ElementID":{ "description":"Element ID", "type":"string", "example":"b1e9b165-5f05-4e41-8031-e9f7586a88f9" }, "ElementName":{ "description":"Element Name", "type":"string", "example":"Element1" } } }, "example":[ { "ElementID":"b1e9b165-5f05-4e41-8031-e9f7586a88f9", "ElementName":"Element1" } ] } }, "type":"object" }, "gatewayGateways":{ "properties":{ "GatewayName":{ "description":"The gateway name.\n
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Gateway1" }, "Description":{ "$ref":"#/components/schemas/gatewayGatewaysRead/properties/Description" }, "Port":{ "$ref":"#/components/schemas/gatewayGatewaysRead/properties/Port" }, "Delimiter":{ "$ref":"#/components/schemas/gatewayGatewaysRead/properties/Delimiter" }, "DeviceID":{ "$ref":"#/components/schemas/gatewayGatewaysRead/properties/DeviceID" }, "ConnectionTypeID":{ "$ref":"#/components/schemas/gatewayGatewaysRead/properties/ConnectionTypeID" }, "Username":{ "$ref":"#/components/schemas/gatewayGatewaysRead/properties/Username" }, "Password":{ "$ref":"#/components/schemas/gatewayGatewaysRead/properties/Password" }, "LoginPrompt":{ "description":"If Connection Type is set to \"SSH Login\" or \"Telnet Login\", optional regex match for login prompt (default is \"[$%#>] $\").", "type":"string" }, "StatusID":{ "$ref":"#/components/schemas/gatewayGatewaysRead/properties/StatusID" }, "Elements":{ "description":"Selection of associated Network Elements for this gateway.", "type":"array", "items":{ }, "example":[ "b1e9b165-5f05-4e41-8031-e9f7586a88f9" ] } }, "type":"object" }, "gatewayGatewaysReadForSelect":{ "properties":{ "GatewayID":{ "$ref":"#/components/schemas/gatewayGatewaysRead/properties/GatewayID" }, "GatewayName":{ "$ref":"#/components/schemas/gatewayGatewaysRead/properties/GatewayName" } }, "type":"object" }, "gatewayElementsRead":{ "properties":{ "ElementID":{ "description":"Unique identifier for the element.", "type":"string", "example":"825f3a56-2697-49e1-a3e6-375dd6fe61eb" }, "ElementName":{ "description":"The name of the element, which must be unique within the database.", "type":"string", "example":"Element1" }, "Description":{ "description":"Description of the Element.", "type":"string", "example":"" }, "TID":{ "description":"Element TID", "type":"string", "example":"tid" }, "CTAG":{ "description":"Element CTAG", "type":"string", "example":"ctag" }, "LoginCommand":{ "description":"Command to login to the element.", "type":"string", "example":"act" }, "LogoutCommand":{ "description":"Command to logout of the element.", "type":"string", "example":"canc" }, "PollTimer":{ "description":"Seconds to wait after running each poll command.", "type":"integer", "example":30 }, "Commands":{ "description":"Poll Commands to run on network element. The order listed is the order commands will be run.", "type":"array", "items":{ }, "example":[ ] }, "GatewayID":{ "description":"Parent Gateway", "type":"string", "example":"18b88a04-5b5d-455c-bc9e-0ad28cf7aee0" }, "GatewayName":{ "description":"The parent gateway for the element.", "type":"string", "example":"Gateway1" } }, "type":"object" }, "gatewayElements":{ "properties":{ "ElementName":{ "description":"The gateway element name.\n
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Element1" }, "Description":{ "$ref":"#/components/schemas/gatewayElementsRead/properties/Description" }, "GatewayID":{ "$ref":"#/components/schemas/gatewayElementsRead/properties/GatewayID" }, "TID":{ "$ref":"#/components/schemas/gatewayElementsRead/properties/TID" }, "CTAG":{ "$ref":"#/components/schemas/gatewayElementsRead/properties/CTAG" }, "LoginCommand":{ "$ref":"#/components/schemas/gatewayElementsRead/properties/LoginCommand" }, "LogoutCommand":{ "$ref":"#/components/schemas/gatewayElementsRead/properties/LogoutCommand" }, "Commands":{ "$ref":"#/components/schemas/gatewayElementsRead/properties/Commands" }, "PollTimer":{ "$ref":"#/components/schemas/gatewayElementsRead/properties/PollTimer" } }, "type":"object" }, "gatewayElementsReadForSelect":{ "properties":{ "ElementID":{ "$ref":"#/components/schemas/gatewayElementsRead/properties/ElementID" }, "ElementName":{ "$ref":"#/components/schemas/gatewayElementsRead/properties/ElementName" } }, "type":"object" }, "graphGraphsRead":{ "properties":{ "Nodes":{ "description":"Nodes in the topology graph (device, router, network interface, etc).", "type":"array", "items":{ "type":"object", "properties":{ "Properties":{ "description":"Properties for the node. The properties will depend on the node type and any custom properties created. The following is a default device-type node list of properties.", "type":"object", "properties":{ "depth":{ "description":"Number of hops (links) to follow", "type":"integer", "example":0 }, "ZoneID":{ "description":"Zone ID", "type":"integer", "example":"3" }, "DeviceID":{ "description":"Device ID", "type":"integer", "example":349 }, "VertexClass":{ "description":"Type of the node", "type":"string", "example":"Device" }, "VertexID":{ "description":"Vertex ID", "type":"string", "example":"1c730895-8505-43a9-ac8e-f18c75edcde9" }, "IPAddress":{ "description":"IP Address", "type":"string", "example":"100.77.220.52" }, "TimestampModified":{ "description":"Time stamp Modified", "type":"string", "example":"2023-09-03 06:00:18" }, "Name":{ "description":"Name of the node", "type":"string", "example":"router.example.com" }, "NodeIcon":{ "description":"Path to the image icon used to represent the node. Each node will only have one of the following- NodeIcon, NodeFontAwesomeIcon, and NodeUANIcon", "type":"string", "example":"fa fa-server-network" }, "NodeFontAwesomeIcon":{ "description":"FontAwesome icon class. Each node will only have one of the following- NodeIcon, NodeFontAwesomeIcon, and NodeUANIcon.", "type":"string", "example":"fa fa-server-network" }, "NodeUANIcon":{ "description":"Universal Assurance Network icon class. Each node will only have one of the following- NodeIcon, NodeFontAwesomeIcon, and NodeUANIcon.", "type":"string" }, "Group":{ "description":"To check the node should be nested as part of the VertexGroupByTypeName or VertexTuckAwayTypeName selection.", "type":"boolean", "example":true } } }, "NodeName":{ "description":"Node Name", "type":"string", "example":"router.example.com" } } } }, "Edges":{ "description":"Links in the topology graph (ConnectsLayer2, ConnectsInterface, etc)", "type":"array", "items":{ "type":"object", "properties":{ "LinkKey":{ "description":"Identifier composed of the source node ID and target node ID.", "type":"string", "example":"bbdcf488-37a1-43ea-b892-b3dde946847d,5438f283-07b5-4367-a36b-a8d3ca9b96fd" }, "RecordId":{ "description":"Identifier composed of edge ID, source node ID, and target node ID.", "type":"string", "example":"4029c7f2-b63d-443c-a855-3b763a16954b_bbdcf488-37a1-43ea-b892-b3dde946847d_5438f283-07b5-4367-a36b-a8d3ca9b96fd" }, "Source":{ "description":"Name of the source vertex.", "type":"string", "example":"router.example.com" }, "Target":{ "description":"Name of the target vertex.", "type":"string", "example":"veth2e99c9f" }, "Properties":{ "description":"Properties for the edge. The properties will depend on the edge type and any custom properties created. The following is a default ConnectsLayer2-type edge list of properties.", "type":"object", "properties":{ "HopCount":{ "description":"Number of hops from the starting vertex", "type":"integer", "example":1 }, "LineSize":{ "description":"Line size", "type":"integer", "example":1 }, "Stroke":{ "description":"Type of edge pattern. \n\nAllowed Values: \n- Solid\n- Dashed", "type":"string", "example":"Solid" }, "TimestampModified":{ "description":"Date and time the edge was created or last modified", "type":"string", "example":"2023-04-18T12:34:22.000Z" }, "Type":{ "description":"The edge type", "type":"string", "example":"HasInterface" }, "TypeDirection":{ "description":"Describes the arrows on the end of the edge.\nAllowed values are:\n
    • Non-Directed: An arrow on both ends of the edge pointing to the source and target.
      • \n
    • Directed: An arrow on one of the edge pointing to the target.
    ", "type":"string", "example":"Non-Directed" } } } } } } } }, "graphGraphsReadForDirectionalTree":{ "properties":{ "Nodes":{ "description":"Nodes in the topology graph (Service, ServiceMetric, etc).", "type":"array", "items":{ "type":"object", "properties":{ "NodeName":{ "description":"Node Name", "type":"string", "example":"Self Monitoring (Manual Thresholds)" }, "Properties":{ "description":"The node properties. The properties will depend on the node type and any custom properties added.", "type":"object" } } } }, "Edges":{ "description":"Links in the topology graph (HasService, HasMetric, etc).", "type":"array", "items":{ "type":"object", "properties":{ "Properties":{ "description":"Properties for the edge. The properties will depend on the edge type and any custom properties added.", "type":"object" } } } } } }, "graphEdgesRead":{ "properties":{ "EdgeTypeID":{ "description":"Edge Type ID", "type":"integer", "example":7 }, "EdgeTypeName":{ "description":"Edge Type Name", "type":"string", "example":"HasTL1Element" }, "OutVertexID":{ "description":"Source Vertex ID", "type":"string", "example":"18b88a04-5b5d-455c-bc9e-0ad28cf7aee0" }, "OutVertexName":{ "description":"Source Vertex Name", "type":"string", "example":"Gateway1" }, "OutVertexCustomName":{ "description":"Source Vertex Custom Name", "type":"string", "example":"" }, "InVertexID":{ "description":"Target Vertex ID", "type":"string", "example":"825f3a56-2697-49e1-a3e6-375dd6fe61eb" }, "InVertexName":{ "description":"Target Vertex Name", "type":"string", "example":"Element1" }, "InVertexCustomName":{ "description":"Target Vertex Custom Name", "type":"string", "example":"" }, "EdgeProps":{ "description":"Edge Properties", "type":"array", "items":{ "type":"object", "properties":{ "PropertyName":{ "description":"The property name.", "type":"string", "example":"EdgeActiveType" }, "PropertyValue":{ "description":"The property value.", "type":"string", "example":"Metric" } } }, "example":[ { "PropertyName":"EdgeActiveType", "PropertyValue":"Metric" } ] }, "EdgeID":{ "description":"Edge ID", "type":"string", "example":"4a611c07-d077-4438-a0b3-d42e7ff488ad_18b88a04-5b5d-455c-bc9e-0ad28cf7aee0_825f3a56-2697-49e1-a3e6-375dd6fe61eb" }, "TimestampModified":{ "description":"Time Stamp Modified", "type":"integer", "example":"1692196209706" }, "TimestampModifiedString":{ "description":"Time Stamp Modified String", "type":"string", "example":"2023-08-16 09:30:09" } }, "type":"object" }, "graphEdges":{ "properties":{ "OutVertexID":{ "description":"Source Vertex ID", "type":"string", "example":"18b88a04-5b5d-455c-bc9e-0ad28cf7aee0" }, "InVertexID":{ "description":"Target Vertex ID", "type":"string", "example":"825f3a56-2697-49e1-a3e6-375dd6fe61eb" }, "EdgeTypeID":{ "description":"Edge Type ID", "type":"integer", "example":7 }, "EdgeProps":{ "description":"Edge Properties", "type":"array", "items":{ "type":"object", "properties":{ "PropertyName":{ "description":"The property name.", "type":"string", "example":"EdgeActiveType" }, "PropertyValue":{ "description":"The property value.", "type":"string", "example":"Metric" } } }, "example":[ { "PropertyName":"EdgeActiveType", "PropertyValue":"Metric" } ] } }, "type":"object" }, "graphEdgesPut":{ "properties":{ "OutVertexID":{ "description":"Source Vertex ID", "type":"string", "example":"18b88a04-5b5d-455c-bc9e-0ad28cf7aee0" }, "InVertexID":{ "description":"Target Vertex ID", "type":"string", "example":"825f3a56-2697-49e1-a3e6-375dd6fe61eb" }, "EdgeProps":{ "description":"Edge Properties", "type":"array", "items":{ "type":"object", "properties":{ "PropertyName":{ "description":"The property name.", "type":"string", "example":"EdgeActiveType" }, "PropertyValue":{ "description":"The property value.", "type":"string", "example":"Metric" } } }, "example":[ { "PropertyName":"EdgeActiveType", "PropertyValue":"Metric" } ] } }, "type":"object" }, "graphEdgeTypesRead":{ "properties":{ "EdgeTypeID":{ "description":"Edge Type ID", "type":"integer", "example":3 }, "EdgeTypeName":{ "description":"Edge Type Name", "type":"string", "example":"ConnectsInterface" }, "Direction":{ "description":"Describes the arrows on the end of the edge.\nAllowed values are:\n
    • Non-Directed: An arrow on both ends of the edge pointing to the source and target.
      • \n
    • Directed: An arrow on one of the edge pointing to the target.
    ", "type":"string", "example":"Non-Directed" }, "LineTypeID":{ "description":"Line Type ID\n\n- 0 => Solid\n- 1 => Dashed\n- 2 => Dotted", "type":"integer", "example":0 }, "LineStyle":{ "description":"Line Style\n\nAllowed Values\n- Solid\n- Dashed\n- Dotted", "type":"string", "example":"Solid" } }, "type":"object" }, "graphEdgeTypesreadForSelect":{ "properties":{ "EdgeTypeID":{ "description":"Edge Type ID", "type":"integer", "example":3 }, "EdgeTypeName":{ "description":"Edge Type Name", "type":"string", "example":"ConnectsLayer2" } }, "type":"object" }, "graphEdgeTypes":{ "properties":{ "EdgeTypeName":{ "description":"The edge type name. The name may not contain spaces, commas, or backticks.\n
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"ConnectsInterface" }, "LineTypeID":{ "description":"The line type ID. Allowed values are:\n
    • 0: Solid
      • \n
    • 1: Dashed
      • \n
    • 2: Dotted
    ", "type":"integer", "example":0 }, "Direction":{ "description":"Describes the arrows on the end of the edge.\nAllowed values are:\n
    • Non-Directed: An arrow on both ends of the edge pointing to the source and target.
      • \n
    • Directed: An arrow on one of the edge pointing to the target.
    ", "type":"string", "example":"Non-Directed" } }, "type":"object" }, "graphNodeDetailsVertexClass":{ "properties":{ "Widgets":{ "description":"The contents of Widgets can changed dramatically based on the vertex and edge properties.The following is just a sample widget.", "type":"array", "items":{ "type":"object", "properties":{ "depth":{ "description":"Number of hops from the start vertex.", "type":"integer", "example":0 }, "ZoneID":{ "description":"Zone ID", "type":"string", "example":"3" }, "DeviceID":{ "description":"Device ID", "type":"integer", "example":349 }, "VertexClass":{ "description":"Type of the node", "type":"string", "example":"Device" }, "VertexID":{ "description":"Vertex ID", "type":"string", "example":"1c730895-8505-43a9-ac8e-f18c75edcde9" }, "IPAddress":{ "description":"IP Address", "type":"string", "example":"100.77.220.52" }, "TimestampModified":{ "description":"Time stamp Modified", "type":"string", "example":"2023-09-03 06:00:18" }, "Name":{ "description":"Name of the node", "type":"string", "example":"Element1" }, "NodeIcon":{ "description":"Path to the image icon used to represent the node. Each node will only have one of the following= NodeIcon, NodeFontAwesomeIcon, and NodeUANIcon", "type":"string", "example":"fa fa-server-network" }, "NodeFontAwesomeIcon":{ "description":"FontAwesome icon class. Each node will only have one of the following= NodeIcon, NodeFontAwesomeIcon, and NodeUANIcon.", "type":"string", "example":"fa fa-server-network" }, "NodeUANIcon":{ "description":"Universal Assurance Network icon class. Each node will only have one of the following= NodeIcon, NodeFontAwesomeIcon, and NodeUANIcon.", "type":"string" }, "Group":{ "description":"To check the node is part of tuck away group.", "type":"boolean", "example":true }, "radius":{ "description":"Node radius", "type":"integer", "example":20 }, "open":{ "description":"Indicates if the node is open (expanded) or not.", "type":"boolean", "example":false }, "groupId":{ "description":"ID to link a nested node back to its parent.", "type":"string", "example":"1c730895-8505-43a9-ac8e-f18c75edcde9" }, "_type":{ "description":"Type of the node", "type":"string", "example":"Device" }, "_id":{ "description":"Vertex Id", "type":"string", "example":"1c730895-8505-43a9-ac8e-f18c75edcde9" } } } } } }, "graphNodeDetailsEdgeClass":{ "properties":{ "Widgets":{ "description":"The contents of Widgets can changed dramatically based on the vertex and edge properties.The following is just a sample widget.", "type":"array", "items":{ "type":"object", "properties":{ "HopCount":{ "description":"Hop Count", "type":"integer", "example":1 }, "LineSize":{ "description":"Width of the edge.", "type":"integer", "example":1 }, "Stroke":{ "description":"Line Style", "type":"string", "example":"Solid" }, "Type":{ "description":"Edge Type", "type":"string", "example":"ConnectsLayer2" }, "TypeDirection":{ "description":"Describes the arrows on the end of the edge.\nAllowed values are:\n
    • Non-Directed: An arrow on both ends of the edge pointing to the source and target.
      • \n
    • Directed: An arrow on one of the edge pointing to the target.
    ", "type":"string", "example":"Non-Directed" }, "TimestampModified":{ "description":"Timestamp Modified", "type":"string", "example":"2023-09-05 06:00:18" }, "id":{ "description":"Edge ID", "type":"string", "example":"c59a9d9e-b610-4a9e-bfec-eb522a218fe8,1c730895-8505-43a9-ac8e-f18c75edcde9,984921d9-35cc-4571-acc9-6158004c7e53_c59a9d9e-b610-4a9e-bfec-eb522a218fe8_1c730895-8505-43a9-ac8e-f18c75edcde9" }, "EdgeClass":{ "description":"Edge Class", "type":"string", "example":"ConnectsLayer2" }, "_type":{ "description":"Edge Class Type", "type":"string", "example":"ConnectsLayer2" }, "_id":{ "description":"Edge Class ID", "type":"string", "example":"984921d9-35cc-4571-acc9-6158004c7e53_c59a9d9e-b610-4a9e-bfec-eb522a218fe8_1c730895-8505-43a9-ac8e-f18c75edcde9" } } } } } }, "graphNodeDetailsReadVertexClass":{ "properties":{ "id":{ "description":"node or edge id.", "type":"string", "example":"ab0ac728-2939-4377-9664-4032b03e99a4" }, "Node":{ "description":"Color indicator for the node status color.", "type":"string", "example":"url(#Gradient1GreenFill)" }, "Performance":{ "description":"Color indicator for the metric status color.", "type":"string", "example":"url(#Gradient1YellowFill)" }, "Event":{ "description":"Color indicator for the event status color.", "type":"string", "example":"url(#Gradient1YellowFill)" } }, "type":"object" }, "graphNodeDetailsReadEdgeClass":{ "properties":{ "id":{ "type":"string", "example":"984921d9-35cc-4571-acc9-6158004c7e53_c59a9d9e-b610-4a9e-bfec-eb522a218fe8_1c730895-8505-43a9-ac8e-f18c75edcde9" }, "Link":{ "type":"string", "example":"url(#Gradient1GrayFill)" }, "EdgeID":{ "type":"string", "example":"c59a9d9e-b610-4a9e-bfec-eb522a218fe8,1c730895-8505-43a9-ac8e-f18c75edcde9,984921d9-35cc-4571-acc9-6158004c7e53_c59a9d9e-b610-4a9e-bfec-eb522a218fe8_1c730895-8505-43a9-ac8e-f18c75edcde9" } }, "type":"object" }, "graphPropertyTypesRead":{ "properties":{ "PropertyID":{ "description":"Property ID", "type":"string", "example":"id-Customer" }, "PropertyName":{ "description":"Property Name", "type":"string", "example":"Customer" }, "RenderType":{ "description":"Render Type", "type":"object", "example":{ "id":"1", "name":"String" } }, "RenderTypeID":{ "description":"Render Type ID", "type":"string", "example":"1" }, "RenderTypeName":{ "description":"Render Type Name", "type":"string", "example":"String" } }, "type":"object" }, "graphPropertyTypesReadForSelect":{ "properties":{ "PropertyName":{ "description":"Property Name", "type":"string", "example":"Customer" }, "RenderType":{ "description":"Render Type", "type":"object", "example":{ "id":"1", "name":"String" } } } }, "graphPropertyTypes":{ "properties":{ "PropertyName":{ "description":"Property Name", "type":"string", "example":"Customer" }, "RenderType":{ "description":"Render Type", "type":"integer", "example":"1" } } }, "graphVertexTypes":{ "properties":{ "VertexTypeName":{ "description":"The vertex type name. The name may not contain spaces, commas, or backticks.\n
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Device" }, "VertexTypeIcon":{ "description":"Vertex type icon. It may be a CSS clas or a path to an image.", "type":"string", "example":"fa fa-brick" }, "Source":{ "description":"The source of the icon. Allowed values:- Image, Font Awesome Icon, or Unified Assurance Icon", "type":"string" } } }, "graphVertexTypesRead":{ "properties":{ "VertexTypeID":{ "description":"Vertex Type ID", "type":"integer", "example":1030 }, "VertexTypeName":{ "description":"Vertex Type Name", "type":"string", "example":"Device" }, "VertexTypeIcon":{ "description":"Vertex type icon. It may be a CSS clas or a path to an image.", "type":"string", "example":"fa fa-brick" }, "VertexTypeIconName":{ "description":"Vertex type icon name. It may be a CSS class or the image name with no path or file extension.", "type":"string", "example":"brick" }, "Source":{ "description":"The source of the icon. Allowed values:- Image, Font Awesome Icon, or Unified Assurance Icon", "type":"string" } }, "type":"object" }, "graphVertexTypesReadForSelect":{ "properties":{ "VertexTypeID":{ "description":"Vertex Type ID", "type":"integer", "example":1030 }, "VertexTypeName":{ "description":"Vertex Type Name", "type":"string", "example":"Device" } }, "type":"object" }, "graphVerticesRead":{ "properties":{ "VertexProps":{ "description":"Vertex properties", "type":"array", "items":{ "type":"object", "properties":{ "PropertyName":{ "description":"Property Name", "type":"string", "example":"ZoneID" }, "PropertyValue":{ "description":"Property Value", "example":3 } } }, "example":[ { "PropertyName":"ZoneID", "PropertyValue":3 } ] }, "VertexTypeID":{ "description":"Vertex type ID", "type":"integer", "example":1 }, "VertexTypeName":{ "description":"Vertex Type Name", "type":"string", "example":"Device" }, "VertexID":{ "description":"Vertex ID", "type":"string", "example":"ab8dc4c9-1da0-40c2-a9c9-8fe8d8fc15fb" }, "TimeStampModified":{ "description":"Timestamp Modified", "type":"integer", "example":"1692270015000" }, "TimeStampModifiedString":{ "description":"Timestamp Modified string", "type":"string", "example":"2023-08-17T06:00:15.000Z" }, "VertexName":{ "description":"Vertex Name", "type":"string", "example":"router.example.com" } }, "type":"object" }, "graphVertices":{ "properties":{ "VertexName":{ "description":"The vertex name.\n
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"router.example.com" }, "VertexTypeID":{ "description":"Vertex Type ID", "type":"integer", "example":1 }, "VertexProps":{ "description":"Vertex Properties", "type":"array", "items":{ "type":"object", "properties":{ "PropertyName":{ "description":"Property Name", "type":"string", "example":"ZoneID" }, "PropertyValue":{ "description":"Property Value", "type":"integer", "example":3 } } }, "example":[ { "PropertyName":"ZoneID", "PropertyValue":3 } ] }, "Viewers":{ "description":"List of user groups that can view", "type":"array", "items":{ }, "example":[ ] } }, "type":"object" }, "graphVerticesUpdate":{ "properties":{ "VertexName":{ "description":"The vertex name.\n
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"router.example.com" }, "VertexProps":{ "description":"Vertex Properties", "type":"array", "items":{ "type":"object", "properties":{ "PropertyName":{ "description":"Property Name", "type":"string", "example":"ZoneID" }, "PropertyValue":{ "description":"Property Value", "type":"integer", "example":3 } } }, "example":[ { "PropertyName":"ZoneID", "PropertyValue":3 } ] }, "Viewers":{ "description":"List of user groups that can view", "type":"array", "items":{ }, "example":[ ] } }, "type":"object" }, "graphVerticesReadProperties":{ "properties":{ "Property":{ "anyOf":[ { "type":"string" }, { "type":"array" } ], "example":[ { "Property":"XYZ Corp" }, { "Property":"ABC Corp" } ] } }, "type":"object" }, "graphVerticesReadForSelect":{ "properties":{ "VertexID":{ "description":"Vertex ID", "type":"string", "example":"ab8dc4c9-1da0-40c2-a9c9-8fe8d8fc15fb" }, "VertexName":{ "description":"Vertex Name", "type":"string", "example":"router.example.com" } }, "type":"object" }, "graphBulkDelete":{ "properties":{ "VertexID":{ "description":"Vertex ID", "type":"string", "example":"ab8dc4c9-1da0-40c2-a9c9-8fe8d8fc15fb" } }, "type":"object" }, "metricMetricsRead":{ "properties":{ "MetricID":{ "description":"Metric ID", "type":"integer", "example":"587889" }, "DeviceID":{ "description":"ID of Device from Assure1.Devices", "type":"integer", "example":"1599" }, "DeviceName":{ "description":"Device Name. The name will be CustomName, DNSName, SysName, IPv6Address, or IPAddress. Whichever value is found first is used.", "type":"string", "example":"460056A" }, "DeviceHost":{ "description":"Device Host. The host is DNSName, IPv6Address, or IPAddress.", "type":"string", "example":"191.1.1.44" }, "MetricTypeID":{ "description":"ID of Metric Type from Assure1.MetricTypes", "type":"integer", "example":"63" }, "MetricTypeName":{ "description":"Metric Type Name", "type":"string", "example":"Ping Jitter Utilization" }, "InstanceID":{ "description":"ID of Instance from Assure1.metricInstances", "type":"integer", "example":"0" }, "MetricName":{ "description":"Metric Name", "type":"string", "example":"Device" }, "DisplayInstanceName":{ "description":"Display Instance Name", "type":"string", "example":"1 Minute Average" }, "InstanceName":{ "description":"Instance Name", "type":"string", "example":"Device" }, "StatusID":{ "description":"The metric status ID. Either 0 (disabled) or 1 (enabled).", "type":"integer", "example":"1" }, "StatusName":{ "description":"Status Name", "type":"string", "example":"Enabled" }, "StatusIcon":{ "description":"Status Icon", "type":"string", "example":"OrbGreen.png" }, "Maximum":{ "description":"Maximum", "type":"integer", "example":"100" }, "DeviceZoneID":{ "description":"Device Zone ID", "type":"integer", "example":"1" }, "DeviceZoneName":{ "description":"Device Zone Name", "type":"string", "example":"Default First Zone" }, "Measurement":{ "description":"The influxDB measurement name.", "type":"string", "example":"metrictype_Ping_Jitter_Utilization" }, "DeviceShardID":{ "description":"Device Shard ID", "type":"integer", "example":"1" }, "CustomMaximum":{ "description":"Metric Custom Maximum to override auto maximum", "type":"number" }, "Factor":{ "description":"Factor", "type":"integer", "example":"1" }, "UnitDivision":{ "description":"Unit division\n\nAllowed Values:\n- 0 => None\n- 60 => Time\n- 1000 => SI (1000)\n- 1024 => Binary/IEC (1024)", "type":"integer", "example":"0" }, "Unit":{ "description":"Unit of the metric type, i.e. Seconds, Errors, Bits per Second, etc.", "type":"string", "example":"Percent" }, "Abbr":{ "description":"Metric Abbreviation", "type":"string", "example":"%" }, "MethodID":{ "description":"ID from Assure1.MetricMethods", "type":"integer", "example":"0" }, "MethodName":{ "description":"Method Name", "type":"string", "example":"NA" }, "PollTime":{ "description":"Metric collection interval (used for display only)", "type":"integer", "example":"300" }, "ShardID":{ "description":"ID of the shard the metric resides on", "type":"integer", "example":"1" }, "Thresholds":{ "description":"collection of assigned thresholds", "type":"array", "items":{ "type":"object", "properties":{ "Measurement":{ "description":"Measurement", "type":"string", "example":"metrictype_Ping_Jitter_Utilization" }, "ThresholdID":{ "description":"Threshold ID", "type":"integer", "example":19 }, "ThresholdName":{ "description":"Threshold Name", "type":"string", "example":"Ping Jitter Utilization High" }, "MetricTypeName":{ "description":"Metric Type Name", "type":"string", "example":"Ping Jitter Utilization" } } } }, "StateName":{ "description":"Flag to indicate if the metric has data. Allowed values:- \"Data Exists\" or \"No Data\"", "type":"string", "example":"No Data" }, "StateIcon":{ "description":"Flag to indicate if the metric has data. Allowed values:- \"OrbGreen.png\" or \"OrbYellow.png\"", "type":"string", "example":"OrbYellow.png" } }, "type":"object" }, "metricMetrics":{ "properties":{ "DeviceName":{ "description":"The serialized device name. The name will be CustomName, DNSName, SysName, IPv6Address, or IPAddress. Whichever value is found first is used. The name is followed by the zone ID.", "type":"string", "example":"device.example.com;z1 OR device.example.com" }, "DeviceZoneName":{ "description":"The zone the device is assigned to. Deprecated. Use serialized device name instead.", "type":"string", "example":"Default First Zone" }, "InstanceID":{ "description":"ID of Instance from Assure1.metricInstances", "type":"integer", "example":"0" }, "MetricTypeID":{ "description":"ID of Metric Type from Assure1.MetricTypes", "type":"integer", "example":"63" }, "ShardID":{ "description":"ID of the shard the metric resides on", "type":"integer", "example":"1" }, "Factor":{ "description":"Factor", "type":"integer", "example":"1" }, "Maximum":{ "description":"Maximum", "type":"integer", "example":"100" }, "CustomMaximum":{ "description":"Metric Custom Maximum to override auto maximum", "type":"number" }, "PollTime":{ "description":"Metric collection interval (used for display only)", "type":"integer", "example":"300" }, "MethodID":{ "description":"ID from Assure1.MetricMethods", "type":"integer", "example":"0" }, "StatusID":{ "description":"The metric status ID. Either 0 (disabled) or 1 (enabled).", "type":"integer", "example":"1" }, "Thresholds":{ "description":"A collection of assigned thresholds.", "type":"array", "items":{ "type":"integer" }, "example":[ 19 ] } }, "type":"object" }, "metricMetricsPut":{ "properties":{ "MetricTypeID":{ "description":"ID of Metric Type from Assure1.MetricTypes", "type":"integer", "example":"63" }, "DeviceID":{ "description":"ID of Device from Assure1.Devices", "type":"integer", "example":"1599" }, "InstanceID":{ "description":"ID of Instance from Assure1.metricInstances", "type":"integer", "example":"0" }, "ShardID":{ "description":"ID of the shard the metric resides on", "type":"integer", "example":"1" }, "StateID":{ "description":"Metric Status\n| Allowed Values:\n| 0 => Disabled\n| 1 => Enabled", "type":"integer", "example":"1" }, "Maximum":{ "description":"Maximum", "type":"integer", "example":"100" }, "CustomMaximum":{ "description":"Metric Custom Maximum to override auto maximum", "type":"number" }, "Factor":{ "description":"Factor", "type":"integer", "example":"1" }, "MethodID":{ "description":"ID from Assure1.MetricMethods", "type":"integer", "example":"0" }, "PollTime":{ "description":"Metric collection interval (used for display only)", "type":"integer", "example":"300" } } }, "metricMetricsReadForSelect":{ "properties":{ "MetricID":{ "description":"Metric ID", "type":"integer", "example":"587889" }, "DeviceID":{ "description":"ID of Device from Assure1.Devices", "type":"integer", "example":"1599" }, "MetricTypeName":{ "description":"Metric Type Name", "type":"string", "example":"Ping Jitter Utilization" }, "InstanceID":{ "description":"ID of Instance from Assure1.metricInstances", "type":"integer", "example":"0" }, "InstanceName":{ "description":"Instance Name", "type":"string", "example":"Device" } }, "type":"object" }, "metricMetricsReadForAllDevices":{ "properties":{ "MetricID":{ "$ref":"#/components/schemas/metricMetricsRead/properties/MetricID" }, "DeviceID":{ "$ref":"#/components/schemas/metricMetricsRead/properties/DeviceID" }, "DeviceName":{ "$ref":"#/components/schemas/metricMetricsRead/properties/DeviceName" }, "DeviceZoneName":{ "$ref":"#/components/schemas/metricMetricsRead/properties/DeviceZoneName" }, "MetricTypeName":{ "$ref":"#/components/schemas/metricMetricsRead/properties/MetricTypeName" }, "MetricName":{ "$ref":"#/components/schemas/metricMetricsRead/properties/MetricName" }, "InstanceName":{ "$ref":"#/components/schemas/metricMetricsRead/properties/InstanceName" }, "DisplayInstanceName":{ "$ref":"#/components/schemas/metricMetricsRead/properties/InstanceName" }, "StatusName":{ "$ref":"#/components/schemas/metricMetricsRead/properties/StatusName" }, "StatusIcon":{ "$ref":"#/components/schemas/metricMetricsRead/properties/StatusIcon" }, "Maximum":{ "$ref":"#/components/schemas/metricMetricsRead/properties/Maximum" }, "Factor":{ "$ref":"#/components/schemas/metricMetricsRead/properties/Factor" }, "MethodName":{ "$ref":"#/components/schemas/metricMetricsRead/properties/MethodName" }, "PollTime":{ "$ref":"#/components/schemas/metricMetricsRead/properties/PollTime" }, "ShardID":{ "$ref":"#/components/schemas/metricMetricsRead/properties/ShardID" }, "StateName":{ "$ref":"#/components/schemas/metricMetricsRead/properties/StateName" }, "StateIcon":{ "$ref":"#/components/schemas/metricMetricsRead/properties/StateIcon" } }, "type":"object" }, "metricAbnormalProfiles":{ "properties":{ "AbnormalProfileName":{ "description":"The name of the abnormal profile.\n
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Default Abnormal Profile" }, "Alpha":{ "description":"The degree to which the confidence bands smooth a weighted average (more weight being given to recent observations, less to older observations). Values are from >0 to 1. The closer to 1 the Alpha value becomes, the closer the predicted value will be to the weighted average of the last n observations.", "type":"number", "example":"0.999497" }, "Beta":{ "description":"The degree to which the smoothing function considers the slope (amount of increase or decrease) of the weighted average of 2 adjacent data points. Values are from >0 to 1. The closer to 1 the Beta value gets, the more the Algorithm will consider the slope of the previous (n-1) data point to the current data point (n) when predicting the next data point (n+1).", "type":"number", "example":"0.00224" }, "Gamma":{ "description":"The degree to which the smoothing function considers seasonal data when forecasting a data point. Values are >0 to 1. The closer to 1 Gamma gets, the more the Algorithm will weight seasonal patterns when forecasting expected values.", "type":"number", "example":"0.487092" }, "Delta":{ "description":"Scaling factor, used to influence the width of the confidence bands generated by the Algorithm. Values are between 2 and 3.", "type":"number", "example":"3" }, "Epsilon":{ "description":"Epsilon scaling. Values are >0 to 1.", "type":"number", "example":"0.492391" }, "WindowLength":{ "description":"Used with Violation Threshold by the Abnormal Thresholding Engine to determine whether to generate a threshold violation event. If Violation Threshold data points fall outside the confidence band within a Window Length number of points, then the data points are considered \"abnormal\" and an event will be generated. Values are between 0 and 28.", "type":"integer", "example":"5" }, "FailureThreshold":{ "description":"Used with Window Length by the Abnormal Thresholding Engine to determine whether to generate a threshold violation event. If Violation Threshold data points fall outside the confidence band within a Window Length number of points, then the data points are considered \"abnormal\" and an event will be generated.", "type":"integer", "example":"3" } }, "type":"object" }, "metricAbnormalProfilesRead":{ "properties":{ "AbnormalProfileID":{ "description":"Abnormal Profile ID", "type":"integer", "example":"1" }, "AbnormalProfileName":{ "description":"Name of abnormal profile", "type":"string", "example":"Default Abnormal Profile" }, "Alpha":{ "description":"The degree to which the confidence bands smooth a weighted average (more weight being given to recent observations, less to older observations). Values are from >0 to 1. The closer to 1 the Alpha value becomes, the closer the predicted value will be to the weighted average of the last n observations.", "type":"number", "example":"0.999497" }, "Beta":{ "description":"The degree to which the smoothing function considers the slope (amount of increase or decrease) of the weighted average of 2 adjacent data points. Values are from >0 to 1. The closer to 1 the Beta value gets, the more the Algorithm will consider the slope of the previous (n-1) data point to the current data point (n) when predicting the next data point (n+1).", "type":"number", "example":"0.00224" }, "Gamma":{ "description":"The degree to which the smoothing function considers seasonal data when forecasting a data point. Values are >0 to 1. The closer to 1 Gamma gets, the more the Algorithm will weight seasonal patterns when forecasting expected values.", "type":"number", "example":"0.487092" }, "Delta":{ "description":"Scaling factor, used to influence the width of the confidence bands generated by the Algorithm. Values are between 2 and 3.", "type":"number", "example":"3" }, "Epsilon":{ "description":"Epsilon scaling. Values are >0 to 1.", "type":"number", "example":"0.492391" }, "WindowLength":{ "description":"Used with Violation Threshold by the Abnormal Thresholding Engine to determine whether to generate a threshold violation event. If Violation Threshold data points fall outside the confidence band within a Window Length number of points, then the data points are considered \"abnormal\" and an event will be generated. Values are between 0 and 28.", "type":"integer", "example":"5" }, "FailureThreshold":{ "description":"Used with Window Length by the Abnormal Thresholding Engine to determine whether to generate a threshold violation event. If Violation Threshold data points fall outside the confidence band within a Window Length number of points, then the data points are considered \"abnormal\" and an event will be generated.", "type":"integer", "example":"3" } }, "type":"object" }, "metricAbnormalProfilesReadForSelect":{ "properties":{ "AbnormalProfileID":{ "description":"Abnormal Profile ID", "type":"integer", "example":"1" }, "AbnormalProfileName":{ "description":"Abnormal Profile Name", "type":"string", "example":"Default Abnormal Profile" } }, "type":"object" }, "metricAllMetricsOverviewRead":{ "properties":{ "MetricID":{ "description":"Metric ID related to the following data.", "type":"integer", "example":"642677" }, "DeviceID":{ "description":"Device ID related to the following data.", "type":"string", "example":"1555" }, "ParentDeviceID":{ "description":"Parent Device ID. It will be 0 if the device is not virtual. It will be another DeviceID if it is a virtual device.", "type":"integer", "example":"0" }, "DeviceName":{ "description":"Device Name", "type":"string", "example":"router.example.com" }, "DNSName":{ "description":"DNS Name", "type":"string", "example":"router.example.com" }, "IPAddress":{ "description":"IP Address", "type":"string", "example":"1192.0.2.1" }, "IPv6Address":{ "description":"IPv6 Address", "type":"string", "example":"2001:DB8::1" }, "DeviceZoneID":{ "description":"Device Zone ID.", "type":"integer", "example":"9" }, "DeviceZoneName":{ "description":"Device Zone Name", "type":"string", "example":"Oracle Lab - Network Equipment" }, "Maximum":{ "description":"Maximum", "type":"integer", "example":"0" }, "MetricTypeName":{ "description":"Metric Type Name", "type":"string", "example":"Latency" }, "Measurement":{ "description":"Measurement", "type":"string", "example":"metrictype_Latency" }, "Abbr":{ "description":"Metric Abbreviation", "type":"string", "example":"s" }, "MetricGroupID":{ "description":"The metric group ID the metric belongs to.", "type":"integer", "example":"6" }, "UnitDivision":{ "description":"Unit Division", "type":"integer", "example":"60" }, "Direction":{ "description":"Direction to sort this metric type in relation to TopN. 0 = descending, 1 = ascending.", "type":"integer", "example":"0" }, "ShardID":{ "description":"Shard ID", "type":"integer", "example":"1" }, "InstanceName":{ "description":"Instance Name", "type":"string", "example":"Device" }, "PollTime":{ "description":"Poll Time", "type":"integer", "example":"60" }, "Factor":{ "description":"Factor", "type":"integer", "example":"1" }, "SourceInstanceName":{ "description":"Source Instance Name", "type":"string", "example":"Device" }, "MDSID":{ "description":"A combination of the MetricID, DeviceID, and ShardID concatenated with an \"_\" underscore character.", "type":"string", "example":"642677_1555_1" }, "Availability":{ "description":"Availability of the metric for the specified time range.", "type":"number", "example":"80" }, "AverageValue":{ "description":"Mean value of the metric for the specified time range.", "type":"number", "example":"1000" }, "MinimumValue":{ "description":"The minimum value of the metric for the specified time range", "type":"number", "example":"0" }, "MaximumValue":{ "description":"The maximum value of the metric for the specified time range", "type":"number", "example":"5000" }, "LastValue":{ "description":"The most recent value of the metric for the specified time range", "type":"number", "example":"0.000558996200561523" }, "AverageUtilization":{ "description":"The most recent value of the metric for the specified time range", "type":"number", "example":"50" }, "MinimumUtilization":{ "description":"The minimum utilization of the metric for the specified time range", "type":"number", "example":"0" }, "MaximumUtilization":{ "description":"The maximum utilization of the metric for the specified time range", "type":"number", "example":"100" }, "LastUtilization":{ "description":"The last utilization reported for the metric for the specified time range", "type":"number", "example":"60" }, "SumValue":{ "description":"The sum of all values for the metric for the specified time range", "type":"number", "example":"300000" }, "Trend":{ "description":"Trend", "type":"integer", "example":null, "nullable":true }, "PeakValue":{ "description":"Peak value is the minimum or maximum depending on metric type direction.", "type":"number", "example":"5000" }, "PeakUtilization":{ "description":"Peak utilization is the minimum or maximum depending on metric type direction.", "type":"number", "example":"100" } }, "type":"object" }, "metricAvailabilityDataRead":{ "properties":{ "DeviceName":{ "description":"Device Name", "type":"string", "example":"router.example.com" }, "MetricInstanceName":{ "description":"Metric Instance Name", "type":"string", "example":"Device" }, "MetricTypeName":{ "description":"Metric Type Name", "type":"string", "example":"Latency" }, "Maximum":{ "description":"Maximum", "type":"integer", "example":"0" }, "MetricID":{ "description":"May be a single value or a comma-separated list", "type":"integer", "example":642677 }, "Unavailability":{ "description":"Array of times and percentage of time it was unavailable for that time period. Availability plus Unavailability plus MissingData should add up to 100.", "type":"array", "items":{ "type":"array", "items":{ "type":"integer" }, "example":[ "1695200400000", 0 ] } }, "Availability":{ "description":"Array of times and percentage of time it was available for that time period. Availability plus Unavailability plus MissingData should add up to 100.", "type":"array", "items":{ "type":"array", "items":{ "type":"integer" }, "example":[ "1695200400000", 100 ] } }, "MissingData":{ "description":"Array of times and percentage of time there was no data for that time period. Availability plus Unavailability plus MissingData should add up to 100.", "type":"array", "items":{ "type":"array", "items":{ "type":"integer" }, "example":[ "1695200400000", 0 ] } }, "BlankData":{ "description":"This is used if the time range goes into the future. It ensures the chart shows the future time properly.", "type":"array", "items":{ "type":"array", "items":{ "type":"integer" }, "example":[ ] } }, "StartTime":{ "description":"Epoch time string", "type":"string", "example":1695201840 }, "StopTime":{ "description":"Epoch time string", "type":"string", "example":1695288240 }, "Retention":{ "description":"The retention period the data is drawn from.", "type":"string", "example":"raw" } }, "type":"object" }, "metricAvailabilityDataReadSummary":{ "properties":{ "DeviceName":{ "description":"Device Name", "type":"string", "example":"router.example.com" }, "MetricInstanceName":{ "description":"Metric Instance Name", "type":"string", "example":"Device" }, "MetricTypeName":{ "description":"Metric Type Name", "type":"string", "example":"Latency" }, "Maximum":{ "description":"Maximum", "type":"integer", "example":"0" }, "MetricID":{ "description":"May be a single value or a comma-separated list", "type":"integer", "example":642677 }, "StartTime":{ "description":"Epoch time string", "type":"string", "example":1695201840 }, "StopTime":{ "description":"Epoch time string", "type":"string", "example":1695288240 }, "Retention":{ "description":"The retention period the data is drawn from.", "type":"string", "example":"raw" }, "GraphData":{ "description":"This holds 2 Type/Value objects. Type is Available and Unavailable. Value is percent of time available (0-100), and percent of time unavailable (0-100).", "type":"array", "items":{ "type":"object", "properties":{ "Type":{ "description":"Type", "type":"string", "example":"Available" }, "Value":{ "description":"Value", "type":"integer", "example":"100" } } }, "example":[ { "Type":"Available", "Value":"100" }, { "Type":"Unavailable", "Value":"0" } ] } }, "type":"object" }, "metricCalculationsRead":{ "properties":{ "PolicyID":{ "description":"PolicyID", "type":"integer", "example":"1" }, "PolicyName":{ "description":"Consolidation Policy Name", "type":"string", "example":"Total Bandwidth Consolidation" }, "PolicyStatusID":{ "description":"The consolidation policy status ID. Either 0 (disabled) or 1 (enabled).", "type":"integer", "example":"1" }, "PolicyStatusIcon":{ "description":"Policy Status Icon", "type":"string", "example":"OrbGreen.png" }, "PolicyStatus":{ "description":"Policy Status", "type":"string", "example":"Enabled" }, "PolicyDescription":{ "description":"Consolidation Policy Description", "type":"string", "example":"Calculate the Total Bandwidth used across a collection and store it as a new meta-metric associated to the first device in the collection" }, "PolicyFormula":{ "description":"Content of Consolidation Policy", "type":"string", "example":"$Log->Message()" }, "Collections":{ "description":"Array of metric collections", "type":"array", "items":{ "type":"object", "properties":{ "CollectionID":{ "description":"Collection ID", "type":"integer", "example":3 }, "CollectionName":{ "description":"Collection Name", "type":"string", "example":"example-bandwidth" } } }, "example":[ { "CollectionID":3, "CollectionName":"example-bandwidth" }, { "CollectionID":5, "CollectionName":"example-bandwidth" }, { "CollectionID":7, "CollectionName":"example-bandwidth" } ] } }, "type":"object" }, "metricCalculations":{ "properties":{ "PolicyName":{ "description":"Consolidation Policy Name\n
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Total Bandwidth Consolidation" }, "PolicyDescription":{ "description":"Consolidation Policy Description", "type":"string", "example":"Calculate the Total Bandwidth used across a collection and store it as a new meta-metric associated to the first device in the collection" }, "PolicyStatusID":{ "description":"The consolidation policy status ID. Either 0 (disabled) or 1 (enabled).", "type":"integer", "example":"1" }, "Collections":{ "description":"Array of metric collections", "type":"array", "items":{ "type":"integer" }, "example":[ 3, 5, 7 ] }, "PolicyFormula":{ "description":"Content of Consolidation Policy", "type":"string", "example":"$Log->Message()" } }, "type":"object" }, "metricCalculationsReadForSelect":{ "properties":{ "PolicyID":{ "description":"PolicyID", "type":"integer", "example":"1" }, "PolicyName":{ "description":"Consolidation Policy Name", "type":"string", "example":"Total Bandwidth Consolidation" } }, "type":"object" }, "metricCalculationsExecuteCheckSyntax":{ "properties":{ "Content":{ "description":"The Perl based processing logic of the calculation", "type":"string" } } }, "metricCategoriesRead":{ "properties":{ "MetricDDOCategoryID":{ "description":"The category ID.", "type":"integer", "example":"1" }, "MetricDDOCategoryName":{ "description":"The category name.", "type":"string", "example":"Health" }, "MetricDDOCategoryPath":{ "description":"Path to the DDO or custom view", "type":"string", "example":"#metric/allMetrics/index?DeviceID=&TimeRange=now-24h..now&MetricSource=All" }, "TabOrder":{ "description":"The tab order index for the specific category", "type":"integer", "example":"1" }, "MetricTypes":{ "description":"Metric types included in this category", "type":"array", "items":{ "type":"object", "properties":{ "MetricTypeID":{ "description":"Metric Type ID", "type":"integer", "example":22 }, "MetricTypeName":{ "description":"MetricTypeName", "type":"string", "example":"Memory Used" } } } } }, "type":"object" }, "metricCategories":{ "properties":{ "MetricDDOCategoryName":{ "description":"The category name.\n
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Health" }, "TabOrder":{ "description":"The tab order index for the specific category", "type":"integer", "example":"1" }, "MetricDDOCategoryPath":{ "description":"Path to the DDO or custom view", "type":"string", "example":"#metric/allMetrics/index?DeviceID=&TimeRange=now-24h..now&MetricSource=All" }, "MetricTypes":{ "description":"Metric types included in this category", "type":"array", "items":{ "type":"object", "properties":{ "MetricTypeID":{ "description":"Metric Type ID", "type":"integer", "example":22 }, "MetricTypeName":{ "description":"MetricTypeName", "type":"string", "example":"Memory Used" }, "Measurement":{ "description":"Measurement", "type":"string", "example":"metrictype_Memory_Used" } } } } }, "type":"object" }, "metricCategoriesReadForSelect":{ "properties":{ "MetricDDOCategoryID":{ "description":"Category ID", "type":"integer", "example":"1" }, "MetricDDOCategoryName":{ "description":"Category name", "type":"string", "example":"Health" } }, "type":"object" }, "metricCategoriesReadMetricTabs":{ "properties":{ "DashboardID":{ "description":"Dashboard ID", "type":"string", "example":"Tab1" }, "DashboardName":{ "description":"Dashboard Name", "type":"string", "example":"Health" }, "TabName":{ "description":"Tab Name", "type":"string", "example":"Health" }, "DashboardValue":{ "description":"The view to load for the tab.", "type":"string", "example":"Metric.allMetricsOverview.crud.view.AllMetricsOverviewView" }, "RenderType":{ "description":"Render Type", "type":"string", "example":{ "id":"1", "name":"String" } }, "Filters":{ "description":"Filter to apply to the grid view once it is loaded.", "type":"object", "properties":{ "property":{ "description":"property", "type":"string", "example":"MetricTypeName" }, "value":{ "description":"Property Value", "type":"string", "example":"^(Memory Used|CPU Utilization|CPU Load Average|Disk Used|Latency)" }, "operator":{ "description":"operator", "type":"string", "example":"re" } } }, "Params":{ "description":"Parameters to pass to the dashboard once it is loaded.", "type":"object", "properties":{ "DeviceID":{ "description":"DeviceID", "type":"integer", "example":"11" }, "TimeRange":{ "description":"TimeRange", "type":"string", "example":"now-24h..now" }, "MetricSource":{ "description":"MetricSource", "type":"string", "example":"All" }, "DeviceSource":{ "description":"DeviceSource", "type":"string", "example":"Device" } } } }, "type":"object" }, "metricCollectionsRead":{ "properties":{ "CollectionID":{ "description":"Collection ID", "type":"integer", "example":"35" }, "CollectionName":{ "description":"Collection Name", "type":"string", "example":"Example_Collection" }, "CollectionDescription":{ "description":"Collection Description", "type":"string", "example":"Description of Collection" }, "CollectionMetricCount":{ "description":"Collection Metric Count", "type":"integer", "example":"4" }, "Metrics":{ "description":"Array of metrics included in the collection.", "type":"array", "items":{ "type":"object", "properties":{ "MetricID":{ "description":"Metric ID", "type":"integer", "example":49009 }, "DeviceName":{ "description":"Device Name", "type":"string", "example":"router.example.com" }, "InstanceName":{ "description":"Instance Name", "type":"string", "example":"ens3" }, "MetricTypeName":{ "description":"Metric Type Name", "type":"string", "example":"Interface Outbound Bandwidth\"" } } } } }, "type":"object" }, "metricCollections":{ "properties":{ "CollectionName":{ "description":"The collection name.\n
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Example_Collection" }, "CollectionDescription":{ "description":"Collection Description", "type":"string", "example":"Description of collection" }, "Metrics":{ "description":"Array of metrics included in the collection.", "type":"array", "items":{ }, "example":[ 49009 ] } }, "type":"object" }, "metricCollectionsReadForSelect":{ "properties":{ "CollectionID":{ "description":"Collection ID", "type":"integer", "example":"35" }, "CollectionName":{ "description":"Collection Name", "type":"string", "example":"Example_Collection" } }, "type":"object" }, "metricCollectionsReadMetricsForSelect":{ "properties":{ "MetricID":{ "description":"Metric ID", "type":"integer", "example":49009 }, "DeviceName":{ "description":"Device Name", "type":"string", "example":"router.example.com" }, "InstanceName":{ "description":"Instance Name", "type":"string", "example":"ens3" }, "MetricTypeName":{ "description":"Metric Type Name", "type":"string", "example":"Interface Outbound Bandwidth" } }, "type":"object" }, "metricDeviceGroupAvailabilityDataRead":{ "properties":{ "OrderPriority":{ "description":"Order Priority", "type":"integer", "example":"1" }, "Type":{ "description":"Type", "type":"string", "example":"Group" }, "TypeIcon":{ "description":"Type Icon", "type":"string", "example":"/resources/assure1/images/icons/fugue/arrow-curve-090.png" }, "StateIcon":{ "description":"State Icon", "type":"string", "example":"/resources/assure1/images/OrbYellowDown.png" }, "ID":{ "description":"Device ID", "type":"integer", "example":"1" }, "Name":{ "description":"Device Name", "type":"string", "example":"Go Up To: Root" }, "DeviceZoneID":{ "description":"Device Zone ID", "type":"integer", "example":"1" }, "DeviceZoneName":{ "description":"Device Zone name.", "type":"string", "example":"Default First Zone" }, "Availability":{ "description":"Availability of device", "type":"string", "example":"8.19%" }, "Depth":{ "type":"integer", "example":"0" }, "Type_ID":{ "description":"Type with device ID", "type":"string", "example":"Group_1" } }, "type":"object" }, "metricDeviceGroupAvailabilityDataReadGroupName":{ "properties":{ "DeviceGroupName":{ "description":"Device Group Name", "type":"string", "example":"Root" } } }, "metricDisplayInstances":{ "properties":{ "DeviceName":{ "description":"Serialized device name the new display instance is associated with.", "type":"string", "example":"router.example.com;z1 OR router.example.com" }, "DeviceZoneName":{ "description":"Device zone name the new display instance is associated with. Deprecated. Use serialized device name instead. Specify either DeviceZoneName or DeviceZoneID.", "type":"string" }, "DeviceZoneID":{ "description":"Database ID of the device zone the new display instance is associated with. Deprecated. Use serialized device name instead. Specify either DeviceZoneName or DeviceZoneID.", "type":"integer" }, "MetricDisplayInstanceName":{ "description":"The custom display name.\n
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"1 Minute Average" }, "InstanceID":{ "description":"Instance ID", "type":"integer", "example":"543" }, "SourceDeviceName":{ "description":"Source device name", "type":"string" }, "SourceDeviceZoneName":{ "description":"Source device zone name. Deprecated. Use serialized device name instead. Specify either SourceDeviceZoneName or SourceDeviceZoneID.", "type":"string" }, "SourceDeviceZoneID":{ "description":"Database ID of the source device zone. Deprecated. Use serialized device name instead. Specify either SourceDeviceZoneName or SourceDeviceZoneID.", "type":"integer" } }, "type":"object" }, "metricDisplayInstancesRead":{ "properties":{ "InstanceID":{ "description":"Instance ID", "type":"integer", "example":"543" }, "DeviceID":{ "description":"Device ID", "type":"integer", "example":"1" }, "DeviceName":{ "description":"Device Name", "type":"string", "example":"router.example.com" }, "DeviceZoneName":{ "description":"Device zone name.", "type":"string", "example":"Default First Zone" }, "SourceDeviceZoneName":{ "description":"Source device zone name.", "type":"string" }, "MetricDisplayInstanceID":{ "description":"Metric DisplayInstance ID", "type":"integer", "example":"35" }, "MetricDisplayInstanceName":{ "description":"Custom display name", "type":"string", "example":"1 Minute Average" }, "InstanceName":{ "description":"Instance Name", "type":"string", "example":"Load-1" }, "SourceDeviceID":{ "description":"Source Device ID", "type":"integer", "example":"1" }, "SourceDeviceName":{ "description":"Source Device Name", "type":"string", "example":"router.example.com" } }, "type":"object" }, "metricDisplayInstancesReadForSelect":{ "properties":{ "MetricDisplayInstanceID":{ "description":"Metric DisplayInstance ID", "type":"integer", "example":"35" }, "MetricDisplayInstanceName":{ "description":"Custom display name", "type":"string", "example":"1 Minute Average" } }, "type":"object" }, "metricInstancesRead":{ "properties":{ "InstanceID":{ "description":"The metric instance ID.", "type":"integer", "example":"235035" }, "InstanceName":{ "description":"The metric instance name.", "type":"string", "example":"Example_Instance" }, "InstanceTypeID":{ "description":"The ID of the metric instance type.", "type":"integer", "example":"2" }, "InstanceType":{ "description":"The metric instance type.", "type":"string", "example":"SNMP Custom" }, "DeviceID":{ "description":"The ID of the device associated with the metric instance.", "type":"integer", "example":"1281" }, "DeviceName":{ "description":"The name of the device associated with the metric instance.", "type":"string", "example":"router.example.com" }, "DeviceZoneName":{ "description":"The zone name of the device associated with the metric instance.", "type":"string", "example":"Default First Zone" }, "DeviceZoneID":{ "description":"The zone ID of the device associated with the metric instance.", "type":"string", "example":"1" } }, "type":"object" }, "metricInstances":{ "properties":{ "DeviceName":{ "description":"The serialized device name. It can be the device name with the zone appended to the end or just the device name.
    \nIf you include the zone here, do not specify the DeviceZoneName or DeviceZoneID parameters.", "type":"string", "example":"router.example.com;z1 OR router.example.com" }, "DeviceZoneName":{ "description":"The name of the device zone, if it is not appended to DeviceName. Deprecated. Use a serialized device name instead.", "type":"string", "example":"Default First Zone" }, "DeviceZoneID":{ "description":"The zone ID of the device associated with the metric instance. Used in combination with DeviceZoneName. Do not specify this if you used a serialized device name in DeviceName.", "type":"string", "example":"1" }, "InstanceName":{ "description":"The metric instance name.\n
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Example_Instance" }, "InstanceTypeID":{ "description":"Instance Type ID", "type":"integer", "example":"2" } }, "type":"object" }, "metricInstancesPut":{ "properties":{ "DeviceName":{ "description":"The serialized device name. It can be the device name with the zone appended to the end or just the device name.
    \nIf you include the zone here, do not specify the DeviceZoneName or DeviceZoneID parameters.", "type":"string", "example":"router.example.com" }, "DeviceZoneName":{ "description":"The name of the device zone, if it is not appended to DeviceName. Deprecated. Use a serialized device name instead.", "type":"string", "example":"Default First Zone" }, "InstanceTypeID":{ "description":"Instance Type ID", "type":"integer", "example":"2" } }, "type":"object" }, "metricInstancesReadForSelect":{ "properties":{ "InstanceID":{ "description":"Instance ID", "type":"integer", "example":"202459" }, "InstanceName":{ "description":"Instance Name", "type":"string", "example":"Example_Instance" } }, "type":"object" }, "metricInstancesReadForSelectByDevice":{ "properties":{ "InstanceID":{ "description":"Instance ID", "type":"integer", "example":"218405" }, "RawInstanceName":{ "description":"Raw Instance Name", "type":"string", "example":"tcp-22" }, "InstanceName":{ "description":"Instance Name", "type":"string", "example":"SSH" } }, "type":"object" }, "metricMeasurementsRead":{ "properties":{ "measurement":{ "description":"The measurement ID.", "type":"string", "example":"metrictype_Interface_Inbound_Bandwidth" }, "description":{ "description":"The metric type name for the measurement.", "type":"string", "example":"Interface Inbound Bandwidth" } }, "type":"object" }, "metricMetricGroupsRead":{ "properties":{ "MetricGroupID":{ "description":"Metric Group ID", "type":"integer", "example":"6" }, "MetricGroupName":{ "description":"Metric Group Name for displaying metrics together", "type":"string", "example":"Device Health" }, "Stacked":{ "description":"Whether graphed grouped metrics are stacked (1) or not (0).", "type":"integer", "example":"0" }, "TypeCount":{ "description":"Number of metric types in the group", "type":"integer", "example":"9" }, "MetricTypes":{ "description":"Metric Types in group", "type":"array", "items":{ "type":"object", "properties":{ "MetricTypeID":{ "description":"Metric Type ID", "type":"integer", "example":61 }, "MetricTypeName":{ "description":"Metric Type Name", "type":"string", "example":"Packet Loss" } } } } }, "type":"object" }, "MetricGroups":{ "properties":{ "MetricGroupName":{ "description":"The metric group name for displaying metrics together.\n
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Device Health" }, "Stacked":{ "description":"Whether graphed grouped metrics are stacked (1) or not (0).", "type":"integer", "example":"0" }, "MetricTypes":{ "description":"Metric Types in group", "type":"array", "items":{ "type":"integer" }, "example":[ 61 ] } }, "type":"object" }, "metricMetricGroupsReadForSelect":{ "properties":{ "MetricGroupID":{ "description":"Metric Group ID", "type":"integer", "example":"6" }, "MetricGroupName":{ "description":"Metric Group Name for displaying metrics together", "type":"string", "example":"Device Health" } }, "type":"object" }, "metricNetworkTrafficRead":{ "properties":{ "DeviceID":{ "description":"Device ID specified for view of metrics. It can be a single value or a comma-separated list of ID's", "type":"string", "example":"1555" }, "ParentDeviceID":{ "description":"Parent Device ID", "type":"integer", "example":"0" }, "DeviceName":{ "description":"Device Name", "type":"string", "example":"router.example.com" }, "DeviceZoneID":{ "description":"DeviceZone ID to indicate which devices to include", "type":"integer", "example":"9" }, "MetricID":{ "description":"May be a single value or a comma-separated list", "type":"integer", "example":642677 }, "Factor":{ "description":"Factor", "type":"integer", "example":"1" }, "MetricTypeName":{ "description":"Metric Type Name", "type":"string", "example":"Latency" }, "OriginalMetricTypeName":{ "description":"Original Metric Type Name", "type":"string", "example":"Latency" }, "Measurement":{ "description":"Measurement", "type":"string", "example":"metrictype_Latency" }, "Abbr":{ "description":"Metric Abbreviation", "type":"string", "example":"s" }, "MetricGroupID":{ "description":"Metric Group ID specified to limit which metrics are included", "type":"integer", "example":"6" }, "UnitDivision":{ "description":"Unit Division", "type":"integer", "example":"60" }, "Direction":{ "description":"Direction", "type":"integer", "example":"0" }, "InstanceName":{ "description":"Instance Name", "type":"string", "example":"Device" }, "IfSpeed":{ "description":"IfSpeed", "type":"string", "example":null }, "InboundAvailability":{ "description":"Inbound Availability", "type":"number", "example":100 }, "InboundTrend":{ "description":"Inbound Trend", "type":"number", "example":"0" }, "InboundMinimumValue":{ "description":"Inbound Minimum Value", "type":"number", "example":"0.000322437286376953" }, "InboundMaximumValue":{ "description":"Inbound Maximum Value", "type":"number", "example":0.0022432804107666 }, "InboundAverageValue":{ "description":"Inbound Average Value", "type":"number", "example":"0.0007496613939244192" }, "InboundPeakValue":{ "description":"Inbound Peak Value", "type":"number", "example":0.0022432804107666 }, "InboundLastValue":{ "description":"Inbound Last Value", "type":"number", "example":"0.000776863098144531" }, "InboundMinimumUtilization":{ "description":"Inbound Minimum Utilization", "type":"number", "example":null, "nullable":true }, "InboundMaximumUtilization":{ "description":"Inbound Maximum Utilization", "type":"number", "example":null, "nullable":true }, "InboundAverageUtilization":{ "description":"Inbound Average Utilization", "type":"number", "example":null, "nullable":true }, "InboundPeakUtilization":{ "description":"Inbound Peak Utilization", "type":"number", "example":null, "nullable":true }, "InboundLastUtilization":{ "description":"Inbound Last Utilization", "type":"number", "example":null, "nullable":true }, "OutboundAvailability":{ "description":"Inbound Last Utilization", "type":"number", "example":"0" }, "OutboundTrend":{ "description":"Out bound Trend", "type":"number", "example":"0" }, "OutboundMinimumValue":{ "description":"Outbound Minimum Value", "type":"number", "example":"0" }, "OutboundMaximumValue":{ "description":"Outbound Maximum Value", "type":"number", "example":"0" }, "OutboundAverageValue":{ "description":"Outbound Average Value", "type":"number", "example":"0" }, "OutboundPeakValue":{ "description":"Outbound Peak Value", "type":"number", "example":"0" }, "OutboundLastValue":{ "description":"Outbound Last Value", "type":"integer", "example":"0" }, "OutboundMinimumUtilization":{ "description":"Outbound Minimum Utilization", "type":"number", "example":"0" }, "OutboundMaximumUtilization":{ "description":"Outbound Maximum Utilization", "type":"number", "example":"0" }, "OutboundAverageUtilization":{ "description":"Outbound Average Utilization", "type":"number", "example":"0" }, "OutboundPeakUtilization":{ "description":"Outbound Peak Utilization", "type":"number", "example":"0" }, "OutboundLastUtilization":{ "description":"Outbound Last Utilization", "type":"number", "example":"0" }, "SourceInstanceName":{ "description":"Source Instance Name", "type":"string", "example":"Device" } }, "type":"object" }, "metricPerformanceData":{ "properties":{ "DeviceID":{ "description":"Device ID (or multiple, comma-separated Device IDs)", "type":"string", "example":"40" }, "DeviceName":{ "description":"The serialized device name (or multiple, comma-separated serialized device names). The device name may be serialized (include the zone id) or just the name if the zone is included separately.", "type":"string", "example":"router.example.com OR router.example.com;z1" }, "GraphTitle":{ "description":"Custom title to be used on the graph", "type":"string" }, "MetricID":{ "description":"Metric ID (or multiple, comma-separated Metric IDs)", "type":"string", "example":" 154" }, "ShowMetricGroup":{ "description":"Show all Metrics in Metric Type Group based on single MetricID", "type":"boolean", "example":"1" }, "MetricType":{ "description":"Metric Type Name (or multiple, comma-separated Metric Type Names)", "type":"string", "example":"Latency" }, "Measurement":{ "description":"Measurement (or multiple, comma-separated Measurements)", "type":"string", "example":"metrictype_Latency" }, "Instance":{ "description":"Metric Instance Name (or multiple, comma-separated Metric Instance Names)", "type":"string", "example":"Device" } }, "type":"object" }, "metricPerformanceDataRead":{ "properties":{ "DeviceName":{ "description":"Device Name\n\nDefined in order or precedence from:\n\n`CustomName > DNSName > SysName > IPv6Address > IPAddress`", "type":"string", "example":"router.example.com" }, "DeviceZoneName":{ "description":"Device zone name", "type":"string" }, "DeviceZoneID":{ "description":"Device zone ID.", "type":"integer" }, "StartTime":{ "description":"Starting epochtime in seconds", "type":"integer", "example":"1234567890" }, "StopTime":{ "description":"Stopping epochtime in seconds", "type":"integer", "example":"1234567890" }, "MetricInstanceName":{ "description":"Metric Display (custom) Instance Name", "type":"string", "example":"Device" }, "ParentDeviceName":{ "description":"Parent Device Name (if virtual)", "type":"string", "example":"parent.example.com" }, "InstanceName":{ "description":"Metric Instance Name", "type":"string", "example":"Device" }, "MetricTypeName":{ "description":"Metric Type Name", "type":"string", "example":"Latency" }, "Unit":{ "description":"Value unit", "type":"string", "example":"bits" }, "Abbr":{ "description":"Unit abbreviation", "type":"string", "example":"b" }, "UnitDivision":{ "description":"Unit division factor", "type":"integer", "example":"1024" }, "Maximum":{ "description":"Metric Maximum (0 for no max)", "type":"integer", "example":"0" }, "MetricID":{ "description":"Metric ID", "type":"integer", "example":"1" }, "Factor":{ "description":"Factor to change units into raw", "type":"integer", "example":"8" }, "PollTime":{ "description":"Poll Time", "type":"integer", "example":"300" }, "MetricGroupName":{ "description":"Metric Group Name for displaying metrics together", "type":"string", "example":"Network Traffic" }, "Stacked":{ "description":"Whether metric stacking is enabled (1) or not (0).", "type":"integer", "example":"0" }, "AverageValue":{ "description":"Average (mean) value", "type":"number", "example":"1000" }, "MinimumValue":{ "description":"Minimum value", "type":"number", "example":"0" }, "MaximumValue":{ "description":"Maximum value", "type":"number", "example":"5000" }, "SumValue":{ "description":"Sum of values over the time range. Not valid for all metrics.", "type":"number", "example":"300000" }, "LastValue":{ "description":"Last value reported", "type":"number", "example":"1500" }, "PeakValue":{ "description":"Peak value is the minimum or maximum depending on metric type direction.", "type":"number", "example":"5000" }, "AverageUtilization":{ "description":"Average (mean) utilization", "type":"number", "example":"50" }, "MinimumUtilization":{ "description":"Minimum utilization", "type":"number", "example":"0" }, "MaximumUtilization":{ "description":"Maximum utilization", "type":"number", "example":"100" }, "LastUtilization":{ "description":"Last utilization reported", "type":"number", "example":"60" }, "PeakUtilization":{ "description":"Peak utilization is the minimum or maximum depending on metric type direction.", "type":"number", "example":"100" }, "TrendSlope":{ "description":"Slope of points over time range", "type":"number", "example":"0.1" }, "retention":{ "description":"Retention period the data was pulled from.", "type":"string" }, "navigationRetention":{ "description":"Retention period the navigation data was pulled from", "type":"string" }, "GraphTitle":{ "description":"Graph title to display based on type of data", "type":"string", "example":"Graph Title" }, "Points":{ "description":"Data points with each point containing the epoch time in milliseconds and value as float\n\n(e.g. `[1234567890000, 1000.00]`)", "type":"array", "items":{ "type":"array", "items":{ "type":"object" } } }, "AbnormalPoints":{ "description":"Abnormal data points with each point containing the epoch time in milliseconds and value as float\n\n(e.g. `[1234567890000, 1000.00]`)", "type":"array", "items":{ "type":"array", "items":{ "type":"object" } } }, "AbnormalConfidence":{ "description":"Abnormal confidence band points with each point containing the epoch time in milliseconds, lower value as float, and upper value as float\n\n(e.g. `[1234567890000, 0.0, 2000.00]`)", "type":"array", "items":{ "type":"array", "items":{ "type":"object" } } }, "NavigatorPoints":{ "description":"Navigator points (full history at lowest granularity) with each point containing the epoch time in milliseconds and value as float\n\n(e.g. `[1234567890000, 1000.00]`)", "type":"array", "items":{ "type":"array", "items":{ "type":"object" } } }, "NavigatorParams":{ "description":"Information necessary to load the navigation asynchronously.", "type":"object", "properties":{ "retention":{ "description":"Retention period used for the navigation", "type":"string" }, "measurement":{ "description":"Metric measurement used for the data", "type":"string" }, "zone":{ "description":"influx query clause for the zone", "type":"string" }, "device":{ "description":"influx query clause for the device", "type":"string" }, "instance":{ "description":"Instance name", "type":"string" }, "dbConn":{ "description":"DB connection ID", "type":"integer" } } }, "TrendPoints":{ "description":"Trend data points with each point containing the epoch time in milliseconds and value as float\n\n(e.g. `[1234567890000, 1000.00]`)", "type":"array", "items":{ "type":"array", "items":{ "type":"object" } } }, "Threshold":{ "description":"Array of threshold definitions", "type":"array", "items":{ "type":"object", "properties":{ "ThresholdName":{ "description":"Threshold name", "type":"string" }, "ThresholdTypeID":{ "description":"Threshold ID", "type":"integer" }, "ThresholdType":{ "description":"Threshold type name", "type":"string" }, "MetricField":{ "description":"Type of metric value used by the threshold. Allowed values:- \"value\", \"utilization\"", "type":"string" }, "WarningOperator":{ "description":"Operator used for the warning state. Allowed values:- \"==\", \"!=\", \">=\", \"<=\", \">\", \"<\"", "type":"string" }, "WarningValue":{ "description":"Warning value", "type":"number" }, "WarningSeverity":{ "description":"Warning Severity. Allowed values:- 0=Normal, 1=Unknown, 2=Info, 3=Minor, 4=Major, 5=Critical", "type":"integer" }, "CriticalOperator":{ "description":"Operator used for the critical state. Allowed values:- \"==\", \"!=\", \">=\", \"<=\", \">\", \"<\"", "type":"string" }, "CriticalValue":{ "description":"Critical value", "type":"number" }, "CriticalSeverity":{ "description":"Critical Severity. Allowed values:- 0=Normal, 1=Unknown, 2=Info, 3=Minor, 4=Major, 5=Critical", "type":"integer" } } } } }, "type":"object" }, "metricPerformanceDataReadMetrics":{ "properties":{ "MetricID":{ "$ref":"#/components/schemas/metricPerformanceData/properties/MetricID" }, "DeviceID":{ "$ref":"#/components/schemas/metricPerformanceData/properties/DeviceID" }, "DeviceMetricID":{ "description":"Device ID and Metric ID concatenated with a hyphen \"-\"", "type":"string", "example":"40-154" }, "DeviceName":{ "$ref":"#/components/schemas/metricPerformanceData/properties/DeviceName" }, "DeviceZoneName":{ "description":"Device zone name", "type":"string", "example":"Default First Zone" }, "MetricTypeName":{ "$ref":"#/components/schemas/metricPerformanceDataRead/properties/MetricTypeName" }, "InstanceName":{ "$ref":"#/components/schemas/metricPerformanceDataRead/properties/InstanceName" }, "DisplayInstanceName":{ "$ref":"#/components/schemas/metricPerformanceDataRead/properties/MetricInstanceName" } }, "type":"object" }, "metricPerformanceDataReadSummary":{ "properties":{ "MetricInstanceName":{ "$ref":"#/components/schemas/metricPerformanceDataRead/properties/MetricInstanceName" }, "Maximum":{ "$ref":"#/components/schemas/metricPerformanceDataRead/properties/Maximum" }, "InstanceName":{ "$ref":"#/components/schemas/metricPerformanceDataRead/properties/InstanceName" }, "MetricTypeName":{ "$ref":"#/components/schemas/metricPerformanceDataRead/properties/MetricTypeName" }, "Measurement":{ "description":"InfluxDB measurement name (or multiple, comma-separated measurements).", "type":"string", "example":"metrictype_Latency" }, "Unit":{ "$ref":"#/components/schemas/metricPerformanceDataRead/properties/Unit" }, "Abbr":{ "$ref":"#/components/schemas/metricPerformanceDataRead/properties/Abbr" }, "UnitDivision":{ "$ref":"#/components/schemas/metricPerformanceDataRead/properties/UnitDivision" }, "Factor":{ "$ref":"#/components/schemas/metricPerformanceDataRead/properties/Factor" }, "PollTime":{ "$ref":"#/components/schemas/metricPerformanceDataRead/properties/PollTime" }, "AverageValue":{ "$ref":"#/components/schemas/metricPerformanceDataRead/properties/AverageValue" }, "MinimumValue":{ "$ref":"#/components/schemas/metricPerformanceDataRead/properties/MinimumValue" }, "MaximumValue":{ "$ref":"#/components/schemas/metricPerformanceDataRead/properties/MaximumValue" }, "SumValue":{ "$ref":"#/components/schemas/metricPerformanceDataRead/properties/SumValue" }, "LastValue":{ "$ref":"#/components/schemas/metricPerformanceDataRead/properties/LastValue" }, "AverageAvailability":{ "description":"Average Availability", "type":"number", "example":"1" }, "MinimumAvailability":{ "description":"Minimum Availability", "type":"number", "example":"1" }, "MaximumAvailability":{ "description":"Maximum Availability", "type":"number", "example":"1" }, "LastAvailability":{ "description":"Last Availability", "type":"number", "example":"1" }, "AverageUtilization":{ "$ref":"#/components/schemas/metricPerformanceDataRead/properties/AverageUtilization" }, "MinimumUtilization":{ "$ref":"#/components/schemas/metricPerformanceDataRead/properties/MinimumUtilization" }, "MaximumUtilization":{ "$ref":"#/components/schemas/metricPerformanceDataRead/properties/MaximumUtilization" }, "LastUtilization":{ "$ref":"#/components/schemas/metricPerformanceDataRead/properties/LastUtilization" } }, "type":"object" }, "metricPerformanceDataReadDetails":{ "properties":{ "Time":{ "description":"Date and time formatted for human readability", "type":"string", "example":"2023-10-03 04:20:00" }, "EpochTime":{ "description":"Epoch Time", "type":"integer", "example":"1696324800000" }, "Value_157":{ "description":"Value of the metric type. Here 157 is metric type ID", "type":"integer", "example":"0.000508975982666016" }, "Value_158":{ "description":"Value of the metric type. Here 158 is metric type ID", "type":"integer", "example":0 }, "Value_159":{ "description":"Value of the metric type. Here 159 is metric type ID", "type":"integer", "example":"0.000560310151841905" } }, "type":"object" }, "metricPollerTemplates":{ "properties":{ "TemplateName":{ "description":"The poller template name.\n
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Default Ping" }, "MetricTypes":{ "description":"Metric Types to be included in the template", "type":"array", "items":{ "type":"integer" }, "example":[ 60, 61, 62, 63 ] } }, "type":"object" }, "metricPollerTemplatesRead":{ "properties":{ "TemplateID":{ "description":"Template ID", "type":"integer", "example":"1" }, "TemplateName":{ "description":"Poller Template Name", "type":"string", "example":"Default Ping" }, "MetricTypeList":{ "description":"Metric Type List", "type":"string", "example":"Latency\n
    Packet Loss\n
    Ping Jitter\n
    Ping Jitter Utilization" }, "MetricTypes":{ "description":"Metric Types to be included in the template", "type":"array", "items":{ "type":"object", "properties":{ "MetricTypeID":{ "description":"Metric Type ID", "type":"integer", "example":60 }, "MetricTypeName":{ "description":"Metric Type Name", "type":"string", "example":"Latency" } } }, "example":[ { "MetricTypeID":60, "MetricTypeName":"Latency" }, { "MetricTypeID":61, "MetricTypeName":"Packet Loss" }, { "MetricTypeID":62, "MetricTypeName":"Ping Jitter" }, { "MetricTypeID":63, "MetricTypeName":"Ping Jitter Utilization" } ] } }, "type":"object" }, "metricPollerTemplatesReadForSelect":{ "properties":{ "TemplateID":{ "description":"Template ID", "type":"integer", "example":"1" }, "TemplateName":{ "description":"Poller Template Name", "type":"string", "example":"Default Ping" } }, "type":"object" }, "metricPollingAssignmentsReadInstances":{ "properties":{ "DeviceID":{ "description":"Device ID", "type":"integer", "example":"757" }, "DeviceInstanceID":{ "description":"Comma-separated list of Instances formatted as DeviceID:InstanceID", "type":"string", "example":"757:0" }, "InstanceID":{ "description":"Instance ID", "type":"integer", "example":"0" }, "DeviceName":{ "description":"Device Name", "type":"string", "example":"router.example.com" }, "InstanceName":{ "description":"Instance Name", "type":"string", "example":"Device" }, "InstanceType":{ "description":"Instance Type", "type":"string", "example":"Device" }, "DeviceZoneID":{ "description":"Device Zone ID", "type":"integer", "example":"9" }, "DeviceZoneName":{ "description":"Device Zone Name", "type":"string", "example":"Oracle Lab - Network Equipment" }, "DeviceGroupName":{ "description":"Device Group Name", "type":"string", "example":"Oracle Lab - Network Equipment" }, "DeviceTypeName":{ "description":"Device Type Name", "type":"string", "example":"vSRX" }, "CategoryName":{ "description":"Category Name", "type":"string", "example":"Router" }, "CategoryImage":{ "description":"Category Image", "type":"string", "example":"mon/NetworkRouter.png" }, "MetaData":{ "description":"MetaData", "type":"string", "example":"" } }, "type":"object" }, "metricPollingAssignments":{ "properties":{ "MethodID":{ "description":"Method ID", "type":"integer", "example":1 }, "PollerTemplateID":{ "description":"Poller Template ID", "type":"integer", "example":8 }, "ThresholdGroupID":{ "description":"Threshold Group ID", "type":"integer", "example":5 }, "PollTime":{ "description":"PollTime", "type":"integer", "example":300 }, "Instances":{ "description":"Comma-separated list of Instances formatted as DeviceID:InstanceID", "type":"string", "example":[ "765:0", "773:0" ] } }, "type":"object" }, "metricPollingPoliciesRead":{ "properties":{ "PolicyID":{ "description":"The policy ID.", "type":"integer", "example":"5" }, "PolicyName":{ "description":"Policy Name", "type":"string", "example":"Configure Network Interface Polling - ens3" }, "StatusID":{ "description":"The metric policy status ID. Either 0 (disabled) or 1 (enabled).", "type":"boolean", "example":"1" }, "StatusName":{ "description":"Status Name", "type":"string", "example":"Enabled" }, "StatusIcon":{ "description":"Status Icon", "type":"string", "example":"OrbGreen.png" }, "PolicyDescription":{ "description":"Policy Description", "type":"string", "example":"" }, "PollTime":{ "description":"PollTime in seconds", "type":"integer", "example":"300" }, "IPRange":{ "description":"IP Range (e.g. 10.*.0-9.1,2,3,4 or 172.16.10.0/24 for CIDR Scan)", "type":"string", "example":"" }, "IPRangeDisplayName":{ "description":"IP Range Display Name. It will be the same as IP Range unless IP Range is blank. Then the display name will be \"Any\".", "type":"string", "example":"Any" }, "CIDR":{ "description":"CIDR\n|Allowed Values:\n|0 => Disabled\n|1 => Enabled", "type":"integer", "example":"1" }, "CIDRDisplayName":{ "description":"A descriptive label for the CIDR flag. Allowed Values are \"Disabled\" and \"Enabled\"", "type":"string", "example":"Disabled" }, "DeviceNameMatchTypeID":{ "description":"The operator to match device names. \n\nAllowed Values: \n- 0 => LIKE\n- 1 => NOT LIKE\n- 2 => REGEXP\n- 3 => NOT REGEXP", "type":"integer", "example":"0" }, "InstanceNameMatchTypeID":{ "description":"The operator to match instance names.\n\nAllowed Values:\n- 0 => LIKE\n- 1 => NOT LIKE\n- 2 => REGEXP\n- 3 => NOT REGEXP", "type":"integer", "example":"0" }, "InstanceTypeID":{ "description":"Instance Type ID", "type":"integer", "example":"1" }, "InstanceTypeName":{ "description":"Instance Type Name", "type":"string", "example":"SNMP Interface" }, "MetaData":{ "description":"MetaData", "type":"string", "example":"" }, "DeviceTypeCategoryID":{ "description":"Device Type Category ID", "type":"integer", "example":"0" }, "SysObjectID":{ "description":"The device type ID to match", "type":"integer", "example":"NONE" }, "PollerTemplateID":{ "description":"Poller Template ID", "type":"integer", "example":"3" }, "TemplateName":{ "description":"Template Name", "type":"string", "example":"Default Network Interface" }, "ThresholdGroupID":{ "description":"Threshold Group ID", "type":"integer", "example":"3" }, "ThresholdGroupName":{ "description":"Threshold Group Name", "type":"string", "example":"Default Network Interface" }, "MethodID":{ "description":"MethodID\n|Allowed Values:\n|0 => NA\n|1 => SNMP\n|2 => WMI\n|3 => Other\n|5 => Transaction", "type":"integer", "example":"1" }, "MethodName":{ "description":"Method Name", "type":"string", "example":"SNMP" }, "Category":{ "description":"Category", "type":"string", "example":"Any" }, "DeviceMetaTypeID":{ "description":"Device MetaType ID", "type":"integer", "example":"0" }, "DeviceMetaTypeName":{ "description":"Device MetaType Name", "type":"string", "example":"ADBaseDN" }, "DeviceName":{ "description":"Device Name", "type":"string", "example":"router.example.com" }, "DeviceDisplayName":{ "description":"Device Display Name", "type":"string", "example":"Any" }, "InstanceName":{ "description":"Instance Name", "type":"string", "example":"ens3" }, "InstanceDisplayName":{ "description":"Instance Display Name", "type":"string", "example":"LIKE/ens3/" }, "MetaDataMatchTypeID":{ "description":"Meta Data Match Type\n\nAllowed Values:\n- 0 => LIKE\n- 1 => NOT LIKE\n- 2 => REGEXP\n- 3 => NOT REGEXP", "type":"integer", "example":"0" }, "MetaDataDisplay":{ "description":"The meta data operator and value unless the value is blank. then the display will be \"Any\".", "type":"string", "example":"Any" }, "DeviceTypeMatchTypeID":{ "description":"Device Type Match Type\n\nAllowed Values:\n- 0 => LIKE\n- 1 => NOT LIKE\n- 2 => REGEXP\n- 3 => NOT REGEXP", "type":"integer", "example":"0" }, "DeviceType":{ "description":"Device Type", "type":"string", "example":"Any" } }, "type":"object" }, "metricPollingPolicies":{ "properties":{ "PolicyName":{ "description":"The polling policy name.\n
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Configure Network Interface Polling - ens3" }, "PolicyDescription":{ "description":"Policy Description", "type":"string", "example":"Description of the policy" }, "StatusID":{ "description":"The metric policy status ID. Either 0 (disabled) or 1 (enabled).", "type":"boolean", "example":"1" }, "IPRange":{ "description":"IP Range (e.g. 10.*.0-9.1,2,3,4 or 172.16.10.0/24 for CIDR Scan)", "type":"string", "example":"172.16.10.0/24" }, "CIDR":{ "description":"CIDR\n\nAllowed Values:\n- 0 => Disabled\n- 1 => Enabled", "type":"integer", "example":"1" }, "DeviceNameMatchTypeID":{ "description":"The operator to match device names. \n\nAllowed Values:\n- 0 => LIKE\n- 1 => NOT LIKE\n- 2 => REGEXP\n- 3 => NOT REGEXP", "type":"integer", "example":"0" }, "DeviceName":{ "description":"Device Name", "type":"string", "example":"router.example.com" }, "DeviceTypeMatchTypeID":{ "description":"Device Type Match Type\n\nAllowed Values:\n- 0 => LIKE\n- 1 => NOT LIKE\n- 2 => REGEXP\n- 3 => NOT REGEXP", "type":"integer", "example":"0" }, "SysObjectID":{ "description":"The device type ID to match.", "type":"integer", "example":"NONE" }, "DeviceTypeCategoryID":{ "description":"Device Type Category ID", "type":"integer", "example":"0" }, "InstanceNameMatchTypeID":{ "description":"The operator to match instance names.\nAllowed Values:\n- 0 => LIKE \n- 1 => NOT LIKE \n- 2 => REGEXP \n- 3 => NOT REGEXP", "type":"integer", "example":"0" }, "InstanceName":{ "description":"Instance Name", "type":"string", "example":"ens3" }, "InstanceTypeID":{ "description":"Instance Type ID", "type":"integer", "example":"1" }, "DeviceMetaTypeID":{ "description":"Device MetaType ID", "type":"integer", "example":"0" }, "MetaDataMatchTypeID":{ "description":"Meta DataMatch Type\n\nAllowed Values:\n- 0 => LIKE\n- 1 => NOT LIKE\n- 2 => REGEXP\n- 3 => NOT REGEXP", "type":"integer", "example":"0" }, "MetaData":{ "description":"MetaData", "type":"string", "example":"" }, "MethodID":{ "description":"MethodID\n\nAllowed Values:\n- 0 => NA\n- 1 => SNMP\n- 2 => WMI\n- 3 => Other\n- 5 => Transaction", "type":"integer", "example":"1" }, "PollerTemplateID":{ "description":"Poller Template ID", "type":"integer", "example":"3" }, "ThresholdGroupID":{ "description":"Threshold Group ID", "type":"integer", "example":"3" }, "PollTime":{ "description":"PollTime in seconds", "type":"integer", "example":"300s" } }, "type":"object" }, "metricRetentionPoliciesReadForSelect":{ "properties":{ "RetentionPolicyName":{ "description":"Retention Policy Name", "type":"string", "example":"raw" }, "RetentionPolicyDuration":{ "description":"Duration in hours", "type":"integer", "example":"336" } }, "type":"object" }, "metricThresholdFunctionsReadForSelect":{ "properties":{ "ThresholdFunctionID":{ "description":"Threshold Function ID", "type":"integer", "example":"1" }, "ThresholdFunctionName":{ "description":"Threshold Function Name", "type":"string", "example":"Mean" } }, "type":"object" }, "metricThresholdGroupsRead":{ "properties":{ "ThresholdGroupID":{ "description":"Threshold Group ID", "type":"integer", "example":"1" }, "ThresholdGroupName":{ "description":"Threshold Group Name", "type":"string", "example":"Default Ping" }, "ThresholdCount":{ "description":"Threshold Count", "type":"integer", "example":"5" }, "MeasurementList":{ "description":"Measurement List", "type":"string", "example":"metrictype_Latency\n
    metrictype_Packet_Loss\n
    metrictype_Ping_Jitter\n
    metrictype_Ping_Jitter_Utilization" }, "MetricTypeNameList":{ "description":"Metric TypeName List", "type":"string", "example":"Latency\n
    Packet Loss\n
    Ping Jitter\n
    Ping Jitter Utilization" }, "Thresholds":{ "description":"Threshold IDs", "type":"array", "items":{ "type":"object", "properties":{ "Measurement":{ "description":"Measurement", "type":"string", "example":"metrictype_Latency" }, "ThresholdID":{ "description":"Threshold ID", "type":"integer", "example":"1" }, "ThresholdName":{ "description":"Threshold Name", "type":"string", "example":"Device Down" }, "MetricTypeName":{ "description":"Metric Type Name", "type":"string", "example":"Latency" } } } } }, "type":"object" }, "metricThresholdGroups":{ "properties":{ "ThresholdGroupName":{ "description":"The threshold group name.\n
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Default Ping" }, "Thresholds":{ "description":"Threshold IDs", "type":"array", "items":{ }, "example":[ 1 ] } }, "type":"object" }, "metricThresholdGroupsReadForSelect":{ "properties":{ "ThresholdGroupID":{ "description":"Threshold Group ID", "type":"integer", "example":"1" }, "ThresholdGroupName":{ "description":"Threshold Group Name", "type":"string", "example":"Default Ping" } }, "type":"object" }, "metricThresholdsRead":{ "properties":{ "ThresholdID":{ "description":"The threshold ID.", "type":"integer", "example":"1" }, "ThresholdName":{ "description":"The threshold name.", "type":"string", "example":"Device Down" }, "Message":{ "description":"The message for the threshold event. Usually appears in an event's Summary field in the event list.", "type":"string", "example":"Performance threshold violation: Device Down" }, "ThresholdTypeID":{ "description":"The ID of the threshold type. Allowed values are:\n
    • 1: Availability - Standard
      • \n
    • 2: Performance Utilization - Standard
      • \n
    • 3: Performance Value - Standard
      • \n
    • 10: Trend % Daily - Advanced
      • \n
    • 14: Abnormal Daily - Advanced
      • \n
    • 16: Missing Data - Advanced
      • \n
    • 20: Trend Prediction Availability - Advanced
      • \n
    • 21: Trend Prediction Performance Utilization - Advanced
      • \n
    • 22: Trend Prediction Performance Value - Advanced
    ", "type":"integer", "example":"1" }, "ThresholdTypeName":{ "description":"The threshold type name", "type":"string", "example":"Standard" }, "StatusID":{ "description":"The metric threshold status ID. Either 0 (disabled) or 1 (enabled).", "type":"boolean", "example":"1" }, "Status":{ "description":"The metric threshold status. Either Disabled or Enabled.", "type":"string", "example":"Enabled" }, "StatusIcon":{ "description":"The metric threshold status icon. For example, a green orb for enabled status.", "type":"string", "example":"OrbGreen.png" }, "AbnormalProfileID":{ "description":"The abnormal profile ID, used by abnormal thresholds only. For all other threshold types, the value of this is 0.", "type":"integer", "example":"0" }, "AbnormalProfileName":{ "description":"The abnormal profile name, used by abnormal thresholds only. For all other threshold types, the value of this is None.", "type":"string", "example":"None" }, "CheckLocation":{ "description":"The location of threshold checking, for standard thresholds only. \nAllowed Values are 1 for the Threshold Engine or 2 for an application.", "type":"integer", "example":"1" }, "CheckLocationName":{ "description":"The name of the check location.", "type":"string", "example":"Threshold Engine" }, "Measurement":{ "description":"The string representing the metric stored in the Metric database.", "type":"string", "example":"metrictype_Latency" }, "MetricTypeName":{ "description":"The metric type name.", "type":"string", "example":"Latency" }, "MetricField":{ "description":"The data type that the threshold checks. Allowed values are:\n
    • availability
      • \n
    • utilization
      • \n
    • value
    ", "type":"string", "example":"availability" }, "TimeRange":{ "description":"Unless Type is set to Abnormal, the period of time in which data points are retrieved and evaluated.
    This must be a combination of a numerical value and one of the following duration values:\n
    • m: Minutes
      • \n
    • h: Hours
      • \n
    • d: Days
      • \n
    • w: Weeks
      • \n
    • M: Months
      • \n
    • Y: Years
    ", "type":"string", "example":"15m" }, "Frequency":{ "description":"Used when Type is set to Standard and CheckLocation is set to Threshold Engine. How often the threshold is checked. This should not be less than the PollTime for the Standard Thresholding Engine (default is one minute) or the metric the threshold is for (default is five minutes).\n
    The format is a combination of a numerical value and one of the following duration values:\n
    • m: Minutes
      • \n
    • h: Hours
      • \n
    • d: Days
      • \n
    • w: Weeks
      • \n
    • M: Months
      • \n
    • Y: Years
    ", "type":"string", "example":"5m" }, "Offset":{ "description":"Used when Type is set to Standard and CheckLocation is set to Threshold Engine. The offset to apply to the time range. For example, set to 5m to go back five minutes when checking the threshold to ensure most recent poll data is considered. Set to 0m for no offset.
    \nThe format is a combination of a numerical value and one of the following duration values:\n
    • m: Minutes
      • \n
    • h: Hours
      • \n
    • d: Days
      • \n
    • w: Weeks
      • \n
    • M: Months
      • \n
    • Y: Years
    ", "type":"string", "example":"0m" }, "ThresholdFunctionID":{ "description":"The threshold function ID.", "type":"integer", "example":"1" }, "ThresholdFunctionName":{ "description":"The threshold function name. Allowed values are:\n
    • 95th Percentile: Use when you do not want to count infrequently-occurring high outliers and odd values, when most data points will be under a certain value.
      • \n
    • Count: Use to ensure there is no missing data, when you expect data points frequently. For example, if you expected a data point every minute, checking a TimeRange of X minutes every Y minutes shows if data is missing after the last Y minutes.
      • \n
    • Maximum: Use to ensure all data is below a certain value.
      • \n
    • Mean: Use to consider the average of the values.
      • \n
    • Minimum: Use to ensure the data never falls below a certain value.
      • \n
    • Standard Deviation: Use when the variation of data points should be below a certain value.
    ", "type":"string", "example":"Mean" }, "WarningOperator":{ "description":"The warning threshold comparison operator. Allowed values are:\n
    • ==
      • \n
    • !=
      • \n
    • >
      • \n
    • >=
      • \n
    • <
      • \n
    • <=
    ", "type":"string", "example":"!=" }, "WarningValue":{ "description":"The warning value to test for.", "type":"number", "example":"0" }, "WarningSeverity":{ "description":"The warning severity, used in the warning event. Allowed Values are:\n
    • 0: Normal
      • \n
    • 1: Info
      • \n
    • 2: Unknown
      • \n
    • 3: Minor
      • \n
    • 4: Major
      • \n
    • 5: Critical
    ", "type":"integer", "example":"3" }, "CriticalOperator":{ "description":"The critical threshold comparison operator. Allowed values are:\n
    • ==
      • \n
    • !=
      • \n
    • >
      • \n
    • >=
      • \n
    • <
      • \n
    • <=
    ", "type":"string", "example":"==" }, "CriticalValue":{ "description":"The critical value to test for.", "type":"number", "example":"0" }, "CriticalSeverity":{ "description":"The critical severity, used in the warning event. Allowed Values are:\n
    • 0: Normal
      • \n
    • 1: Info
      • \n
    • 2: Unknown
      • \n
    • 3: Minor
      • \n
    • 4: Major
      • \n
    • 5: Critical
    ", "type":"integer", "example":"5" }, "ForecastTimeRange":{ "description":"Used when Type is set to Trend Prediction. The relative time, starting now, to use when predicting when the metric value will breach the threshold. For example, set it to 6M to notify when the threshold is expected to be breached within six months.\n
    The format is a combination of a numerical value and one of the following duration values:\n
    • m: Minutes
      • \n
    • h: Hours
      • \n
    • d: Days
      • \n
    • w: Weeks
      • \n
    • M: Months
      • \n
    • Y: Years
    ", "type":"string", "example":"6M" } }, "type":"object" }, "metricThresholds":{ "properties":{ "ThresholdName":{ "description":"The threshold name.\n
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Device Down" }, "ThresholdTypeID":{ "description":"The ID of the threshold type. Allowed values are:\n
    • 1: Availability - Standard
      • \n
    • 2: Performance Utilization - Standard
      • \n
    • 3: Performance Value - Standard
      • \n
    • 10: Trend % Daily - Advanced
      • \n
    • 14: Abnormal Daily - Advanced
      • \n
    • 16: Missing Data - Advanced
      • \n
    • 20: Trend Prediction Availability - Advanced
      • \n
    • 21: Trend Prediction Performance Utilization - Advanced
      • \n
    • 22: Trend Prediction Performance Value - Advanced
    ", "type":"integer", "example":"1" }, "AbnormalProfileID":{ "description":"The abnormal profile ID, used for abnormal thresholds only. For all other threshold types, set this to 0.", "type":"integer", "example":"0" }, "Measurement":{ "description":"The string representing the metric stored in the Metric database.", "type":"string", "example":"metrictype_Latency" }, "MetricField":{ "description":"The data type that the threshold checks. Allowed values are:\n
    • availability
      • \n
    • utilization
      • \n
    • value
    ", "type":"string", "example":"availability" }, "TimeRange":{ "description":"Unless Type is set to Abnormal, the period of time in which data points are retrieved and evaluated.
    The format is a combination of a numerical value and one of the following duration values:\n
    • m: Minutes
      • \n
    • h: Hours
      • \n
    • d: Days
      • \n
    • w: Weeks
      • \n
    • M: Months
      • \n
    • Y: Years
    ", "type":"string", "example":"15m" }, "ForecastTimeRange":{ "description":"Used when Type is set to Trend Prediction. The relative time, starting now, to use when predicting when the metric value will breach the threshold. For example, set it to 6M to notify when the threshold is expected to be breached within six months.\n
    The format is a combination of a numerical value and one of the following duration values:\n
    • m: Minutes
      • \n
    • h: Hours
      • \n
    • d: Days
      • \n
    • w: Weeks
      • \n
    • M: Months
      • \n
    • Y: Years
    ", "type":"string", "example":"6M" }, "Frequency":{ "description":"Used when Type is set to Standard and CheckLocation is set to Threshold Engine. How often the threshold is checked.
    \nUse the following guidelines: \n
    • Because thresholds can only be checked as frequently as the Standard Thresholding Engine polls, you must set this to a value greater than or equal to the PollTime of the Standard Thresholding Engine (the default is one minute).
      • \n
    • Because metric values are only updated when the metric is polled, you must set this to a value greater than or equal to the PollTime of the metric the threshold is for (the default is five minutes).
    \nThe format is combination of a numerical value and one of the following duration values:\n
    • m: Minutes
      • \n
    • h: Hours
      • \n
    • d: Days
      • \n
    • w: Weeks
      • \n
    • M: Months
      • \n
    • Y: Years
    ", "type":"string", "example":"5m" }, "Offset":{ "description":"Used when Type is set to Standard and CheckLocation is set to Threshold Engine. The offset to apply to the time range. For example, set to 5m to go back five minutes when checking the threshold to ensure most recent poll data is considered. Set to 0m for no offset.
    This must be a combination of a numerical value and one of the following duration values:\n
    • m: Minutes
      • \n
    • h: Hours
      • \n
    • d: Days
      • \n
    • w: Weeks
      • \n
    • M: Months
      • \n
    • Y: Years
    ", "type":"string", "example":"0m" }, "ThresholdFunctionID":{ "description":"The threshold function ID.", "type":"integer", "example":"1" }, "WarningOperator":{ "description":"The warning threshold comparison operator. Allowed values are:\n
    • ==
      • \n
    • !=
      • \n
    • >
      • \n
    • >=
      • \n
    • <
      • \n
    • <=
    ", "type":"string", "example":"!=" }, "WarningValue":{ "description":"The warning value to test for.", "type":"number", "example":"0" }, "WarningSeverity":{ "description":"The warning severity, used in the warning event. Allowed Values are:\n
    • 0: Normal
      • \n
    • 1: Info
      • \n
    • 2: Unknown
      • \n
    • 3: Minor
      • \n
    • 4: Major
      • \n
    • 5: Critical
    ", "type":"string", "example":"3" }, "CriticalOperator":{ "description":"The critical threshold comparison operator. Allowed values are:\n
    • ==
      • \n
    • !=
      • \n
    • >
      • \n
    • >=
      • \n
    • <
      • \n
    • <=
    ", "type":"string", "example":"==" }, "CriticalValue":{ "description":"The critical value to test for.", "type":"number", "example":"0" }, "CriticalSeverity":{ "description":"The critical severity, used in the warning event. Allowed Values are:\n
    • 0: Normal
      • \n
    • 1: Info
      • \n
    • 2: Unknown
      • \n
    • 3: Minor
      • \n
    • 4: Major
      • \n
    • 5: Critical
    ", "type":"string", "example":"5" }, "Message":{ "description":"The message for the threshold event. Usually appears in an event's Summary field in the event list.", "type":"string", "example":"Performance threshold violation: Device Down" }, "StatusID":{ "description":"The metric threshold status ID. Either 0 (disabled) or 1 (enabled).", "type":"boolean", "example":"1" } } }, "metricThresholdsReadForSelect":{ "properties":{ "ThresholdID":{ "description":"The threshold ID.", "type":"integer", "example":"1" }, "ThresholdName":{ "description":"The threshold name.", "type":"string", "example":"Device Down" }, "Measurement":{ "description":"The string representing the metric stored in the Metric database.", "type":"string", "example":"metrictype_Latency" }, "MetricTypeName":{ "description":"The metric type name.", "type":"string", "example":"Latency" } }, "type":"object" }, "metricThresholdTypesReadForSelect":{ "properties":{ "ThresholdTypeID":{ "description":"The threshold type ID.", "type":"integer", "example":"1" }, "ThresholdTypeName":{ "description":"The threshold type name.", "type":"string", "example":"Standard" } }, "type":"object" }, "metricTopNDataRead":{ "properties":{ "Title":{ "description":"Title", "type":"string", "example":"Latency {{{ Average Value }}}" }, "ShardID":{ "description":"Shard ID", "type":"integer", "example":"2" }, "StoreData":{ "type":"object", "properties":{ "items":{ "description":"Each record is a row of TopN data.", "type":"array", "items":{ "type":"object", "properties":{ "rank":{ "description":"TopN rank", "type":"integer", "example":1 }, "reportValue":{ "description":"Value being scored", "type":"number", "example":0.0019034508784004527 }, "device":{ "description":"Device name", "type":"string", "example":"router.example.com" }, "deviceZoneID":{ "description":"Device zone ID.", "type":"integer", "example":"9" }, "zone":{ "description":"Device zone name.", "type":"string", "example":"Oracle Lab - test" }, "instance":{ "description":"Metric instance name.", "type":"string", "example":"device" }, "metrictype":{ "description":"Metric type name", "type":"string", "example":"Latency" }, "measurement":{ "description":"InfluxDB measurement name", "type":"string", "example":"metrictype_Latency" }, "abbr":{ "description":"Metric unit abbreviation", "type":"string", "example":"s" }, "topnScope":{ "description":"ID of the TopN scope type: \n\nAllowed Values: 0=Disabled, 1=Utilization, 2=Value, 3=Both", "type":"integer", "example":"3" }, "unitDivision":{ "description":"Unit division.\n\nAllowed Values:\n- 0 => None\n- 60 => Time\n- 1000 => SI (1000)\n- 1024 => Binary/IEC (1024)", "type":"integer", "example":"60" } } } } } } }, "type":"object" }, "metricTopNDataReadTitle":{ "properties":{ "title":{ "description":"title", "type":"string", "example":"Top-10 : (Device Group: Oracle Lab - test)" } }, "type":"object" }, "metricTransactionsRead":{ "properties":{ "TransactionID":{ "description":"Transaction ID", "type":"integer", "example":"2" }, "TransactionName":{ "description":"Transaction Name", "type":"string", "example":"Web Transaction" }, "TransactionStatusIcon":{ "description":"Transaction Status Icon\n\nAllowed values\n- OrbRed.png\n- OrbGreen.png", "type":"string", "example":"OrbGreen.png" }, "TransactionStatus":{ "description":"Transaction Status\n\nAllowed values:\n- Disable\n- Enabled", "type":"string", "example":"Enabled" }, "TransactionDescription":{ "description":"Transaction Description", "type":"string", "example":"Using Mechanize library to parse a web site and verify how long it takes to load and if it returns a search criteria" }, "TransactionText":{ "description":"Content of Transaction", "type":"string", "example":"" }, "TransactionStatusID":{ "description":"The transaction status ID. Either 0 (disabled) or 1 (enabled).", "type":"integer", "example":"1" }, "MetricTypeID":{ "description":"Metric Type associated to Transaction", "type":"integer", "example":"90" }, "MetricTypeName":{ "description":"Metric Type Name", "type":"string", "example":"Response Times" } }, "type":"object" }, "metricTransactions":{ "properties":{ "TransactionName":{ "description":"The transaction name.\n
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Web Transaction" }, "TransactionDescription":{ "description":"Transaction Description", "type":"string", "example":"Using Mechanize library to parse a web site and verify how long it takes to load and if it returns a search criteria" }, "MetricTypeID":{ "description":"Metric Type associated to Transaction", "type":"integer", "example":"90" }, "TransactionStatusID":{ "description":"The transaction status ID. Either 0 (disabled) or 1 (enabled).", "type":"integer", "example":"1" }, "TransactionText":{ "description":"Content of Transaction", "type":"string", "example":"Content of Transaction " } }, "type":"object" }, "metricTransactionsReadForSelect":{ "properties":{ "TransactionID":{ "description":"Transaction ID", "type":"integer", "example":"2" }, "TransactionName":{ "description":"Transaction Name", "type":"string", "example":"Web Transaction" } }, "type":"object" }, "metricTransactionsExecuteCheckSyntax":{ "properties":{ "Content":{ "description":"The Perl based processing logic of the transaction policy.", "type":"string" } } }, "metricTypes":{ "properties":{ "MetricTypeName":{ "description":"The metric type name.\n
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Apache Accesses" }, "MetricGroupID":{ "description":"Metric Group ID", "type":"integer", "example":"141" }, "FormatID":{ "description":"Format ID \nAllowed Values:\n- 0 => Integer\n- 1 => Float", "type":"integer", "example":"0" }, "Unit":{ "description":"Type Unit", "type":"string", "example":"Connections" }, "Abbr":{ "description":"Type Abbreviation", "type":"string", "example":"Conn" }, "ValueType":{ "description":"Value Type\n\nAllowed Values:\n- 0 => Raw\n- 100 => Utilization", "type":"integer", "example":"0" }, "UnitDivisionID":{ "description":"UnitDivisionID\n\nAllowed Values:\n- 0 => None\n- 60 => Time\n- 1000 => SI (1000)\n- 1023 => Deprecated Binary (1000)\n- 1024 => Binary/IEC (1024)", "type":"integer", "example":"0" }, "Direction":{ "description":"Direction\n\nAllowed Values:\n- 0 => Descending (Normal)\n- 1 => Ascending", "type":"integer", "example":"0" }, "TopNTypeID":{ "description":"TopNType\n\nAllowed Values:\n- 0 => Both\n- 1 => Average\n- 2 => Peak", "type":"integer", "example":"0" }, "TopNScopeID":{ "description":"TopNScope\n\nAllowed Values:\n- 0 => Disabled\n- 1 => Utilization\n- 2 => Value\n- 3 => Both", "type":"integer", "example":"0" } }, "type":"object" }, "metricTypesRead":{ "properties":{ "MetricTypeID":{ "description":"Metric Type ID", "type":"integer", "example":"515" }, "MetricTypeName":{ "description":"Metric Type Name", "type":"string", "example":"Apache Accesses" }, "MetricGroupID":{ "description":"Metric Group ID", "type":"integer", "example":"141" }, "Measurement":{ "description":"Measurement", "type":"string", "example":"metrictype_Apache_Accesses" }, "MetricGroupName":{ "description":"Metric Group Name for displaying metrics together", "type":"string", "example":"Network Traffic" }, "FormatID":{ "description":"Format ID \nAllowed Values:\n- 0 => Integer\n- 1 => Float", "type":"integer", "example":"0" }, "FormatName":{ "description":"Format. \n\nAllowed Values:\n- Integer\n- Float", "type":"string", "example":"Integer" }, "Unit":{ "description":"Type Unit", "type":"string", "example":"Connections" }, "Abbr":{ "description":"Type Abbreviation", "type":"string", "example":"Conn" }, "ValueType":{ "description":"Value type\n\nAllowed Values:\n- 0 => Raw\n- 100 => Utilization", "type":"integer", "example":"0" }, "ValueTypeName":{ "description":"Value type name\n\nAllowed Values:\n- Raw\n- Utilization", "type":"string", "example":"Raw" }, "Direction":{ "description":"Direction\n\nAllowed Values:\n- 0 => Descending (Normal)\n- 1 => Ascending", "type":"integer", "example":"0" }, "DirectionName":{ "description":"Sort direction\n\nAllowed Values:\n- Descending (Normal)\n- Ascending", "type":"string", "example":"Descending (Normal)" }, "TopNTypeID":{ "description":"TopN Type\n\nAllowed Values:\n- 0 => Both\n- 1 => Average\n- 2 => Peak", "type":"integer", "example":"0" }, "TopNTypeName":{ "description":"TopN Type\n\nAllowed Values:\n- Both\n- Average\n- Peak", "type":"string", "example":"Both" }, "TopNScopeID":{ "description":"TopNScope\n\nAllowed Values:\n- 0 => Disabled\n- 1 => Utilization\n- 2 => Value\n- 3 => Both", "type":"integer", "example":"0" }, "TopNScopeName":{ "description":"TopN scope\n\nAllowed Values:\n- Disabled\n- Utilization\n- Value\n- Both", "type":"string", "example":"Disabled" }, "UnitDivisionID":{ "description":"UnitDivisionID\n\nAllowed Values:\n- 0 => None\n- 60 => Time\n- 1000 => SI (1000)\n- 1023 => Deprecated Binary (1000)\n- 1024 => Binary/IEC (1024)", "type":"integer", "example":"0" }, "UnitDivisionName":{ "description":"Unit division\n\nAllowed values\n- None\n- Time\n- SI(1000)\n- Deprecated Binary(1000)\n- Binary/IEC(1024)", "type":"string", "example":"None" } }, "type":"object" }, "metricTypesReadForSelect":{ "properties":{ "MetricTypeID":{ "description":"Metric Type ID", "type":"integer", "example":"515" }, "MetricTypeName":{ "description":"Metric Type Name", "type":"string", "example":"Apache Accesses" }, "Measurement":{ "description":"InfluxDB measurement name", "type":"string", "example":"metrictype_Apache_Accesses" } }, "type":"object" }, "microserviceCatalogsRead":{ "properties":{ "apiVersion":{ "description":"Version of the api", "type":"string", "example":"v1" }, "appVersion":{ "description":"Version of the app", "type":"string", "example":"v6.0.3-0.0.54" }, "created":{ "description":"Latest created timestamp of the app", "type":"string", "example":"2023-10-18T05:02:25.841191421Z" }, "description":{ "description":"Description of the microservice", "type":"string", "example":"Collects and processes data from example-poller" }, "name":{ "description":"Name of the microservice", "type":"string", "example":"example-poller" }, "urls":{ "description":"urls", "type":"array", "items":{ }, "example":[ "example-poller-6.0.3.tgz" ] }, "version":{ "description":"Version of Helm chart", "type":"string", "example":"6.0.3" }, "icon":{ "description":"Icon of the app", "type":"string", "example":"/resources/assure1/images/icons/microservice/app.png" }, "createdDate":{ "description":"Latest created date of the app", "type":"string", "example":"2023-10-18" } }, "type":"object" }, "microserviceClustersRead":{ "properties":{ "ClusterID":{ "description":"Cluster ID", "type":"integer", "example":"9" }, "ClusterName":{ "description":"Cluster Name", "type":"string", "example":"pri-pres-cluster" }, "ClientServerID":{ "description":"Client Server ID", "type":"integer", "example":"1" }, "RepoHostFQDN":{ "description":"Repo Host FQDN", "type":"string", "example":"server.example.com" } }, "type":"object" }, "microserviceClustersReadForServers":{ "properties":{ "ClusterID":{ "$ref":"#/components/schemas/microserviceClustersRead/properties/ClusterID" }, "ClusterName":{ "$ref":"#/components/schemas/microserviceClustersRead/properties/ClusterName" }, "ClientServerID":{ "$ref":"#/components/schemas/microserviceClustersRead/properties/ClientServerID" }, "RepoHostFQDN":{ "$ref":"#/components/schemas/microserviceClustersRead/properties/RepoHostFQDN" }, "ServerID":{ "description":"Server ID", "type":"integer", "example":"9" }, "Master":{ "type":"integer", "example":"1" }, "Worker":{ "type":"integer", "example":"1" }, "ServerHostFQDN":{ "description":"Server Host FQDN", "type":"string", "example":"server.example.com" }, "WebFQDN":{ "description":"Web FQDN", "type":"string", "example":"server.example.com" }, "CustomName":{ "description":"Custom Name", "type":"string", "example":"" } }, "type":"object" }, "microserviceDeployReadForReleaseName":{ "properties":{ "release":{ "description":"release", "type":"string", "example":"default (values.yaml)" } }, "type":"object" }, "microserviceDeployReadClusterData":{ "properties":{ "namespace":{ "description":"Logical grouping of resources within a cluster", "type":"string", "example":[ { "namespace":"a1-cache" }, { "namespace":"a1-messaging" } ] } }, "type":"object" }, "microserviceDeployRead":{ "properties":{ "cluster":{ "description":"cluster Name", "type":"string", "example":"cluster-1" }, "CustomValues":{ "description":"Custom Values", "type":"string", "example":"# Default values for example-poller/n/nglobal:/n imageRegistry: replicaCount: 1/n/nimage:/n" }, "Helmchart":{ "description":"The name of the Helm chart package", "type":"string", "example":"example-poller" }, "Namespace":{ "description":"Logical grouping of resources within a cluster", "type":"string", "example":"kube-system" }, "ReleaseName":{ "description":"- Release name for the installed Helm chart. \n- 53 chars max and the release name must pass this regex test: `[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*`", "type":"string", "example":"example-poller-deploy" }, "Version":{ "description":"Version of Helm chart", "type":"string", "example":"6.0.3" } }, "required":[ "cluster", "Namespace", "Helmchart", "Version", "ReleaseName" ], "type":"object" }, "microserviceDeployReadForInstalled":{ "properties":{ "name":{ "description":"Microservice Name", "type":"string", "example":"example-poller" }, "namespace":{ "description":"Logical grouping of resources within a cluster", "type":"string", "example":"a1-monitoring" }, "revision":{ "description":"revision", "type":"integer", "example":"1" }, "updated":{ "description":"Updated time of microservice deployment", "type":"string", "example":"2023-10-1913:08:39" }, "status":{ "description":"Status whether deployed or undeployed", "type":"string", "example":"deployed" }, "chart":{ "description":"Installed Helm charts Names", "type":"string", "example":"example-poller-6.0.3" }, "app_version":{ "description":"Version of the app", "type":"string", "example":"v6.0.3-0.0.54" }, "icon":{ "description":"App Icon", "type":"string", "example":"/resources/assure1/images/icons/microservice/app.png" }, "cluster":{ "description":"cluster Name", "type":"string", "example":"cluster-1" } }, "type":"object" }, "microserviceWorkloadReadForTree":{ "properties":{ "id":{ "description":"ID of the tree node to which it points to", "type":"string", "example":"/cluster-1/a1-cache" }, "leaf":{ "description":"Leaf Node of the tree", "type":"boolean", "example":false }, "text":{ "description":"Namespace type", "type":"string", "example":"a1-cache" } }, "type":"object" }, "microserviceWorkloadReadForTreeClusters":{ "properties":{ "id":{ "description":"ID of the tree node to which it points to", "type":"string", "example":"/cluster-1" }, "leaf":{ "description":"Leaf Node of the tree", "type":"boolean", "example":false }, "text":{ "description":"Cluster Name", "type":"string", "example":"cluster-1" } }, "type":"object" }, "microserviceWorkloadReadForTreeNamespace":{ "properties":{ "id":{ "description":"ID of the tree node to which it points to", "type":"string", "example":"/cluster-1/a1-cache" }, "leaf":{ "description":"Leaf Node of the tree", "type":"boolean", "example":false }, "text":{ "description":"Namespace", "type":"string", "example":"a1-cache" } }, "type":"object" }, "microserviceWorkloadReadLogs":{ "properties":{ "time":{ "description":"Time stamp", "type":"string", "example":"2023-10-20T10:18:23.391270632Z" }, "container":{ "description":"Container Name", "type":"string", "example":"container-node" }, "message":{ "description":"A message for the log entry generated by the container.", "type":"string", "example":"2023-10-20 10:18:23.391 [INFO][52] cni-config-monitor/token_watch.go 225: Update of CNI kubeconfig triggered based on elapsed time." } }, "type":"object" }, "navigationBookmarksRead":{ "properties":{ "BookmarkID":{ "description":"Bookmark ID", "type":"integer", "example":"1001" }, "BookmarkName":{ "description":"Bookmark Name", "type":"string", "example":"Display Instances" }, "LinkPath":{ "description":"Bookmark link - has to be in deeplink format", "type":"string", "example":"/#metric/displayInstances" }, "IconCls":{ "description":"Icon class for the bookmark link", "type":"string", "example":"fa-desktop fa x-menu-item-glyph " } }, "type":"object" }, "navigationBookmarks":{ "properties":{ "BookmarkName":{ "description":"Bookmark display name", "type":"string", "example":"Display Instances" }, "LinkPath":{ "description":"The URL path to the UI to bookmark, without the host name, starting with /#.
    For example, if the URL with the host FQDN is https://<hostFQDN>/#metric/displayInstances, LinkPath would be /#metric/displayInstances.", "type":"string", "example":"/#metric/displayInstances" }, "IconCls":{ "description":"FontAwesome icon class. Icon class for the bookmark link.", "type":"string", "example":"fa-desktop fa x-menu-item-glyph " }, "UserID":{ "description":"The current logged-in user's ID or a user ID (the issuer must have admin privileges).", "type":"integer", "example":1 } }, "required":[ "BookmarkName", "LinkPath", "IconCls", "UserID" ], "type":"object" }, "notificationProfilesRead":{ "properties":{ "ProfileID":{ "description":"Profile ID", "type":"integer", "example":1 }, "ProfileTypeID":{ "description":"ID of Notification Profile Type. \n\nPossible values: \n- 1 => Email\n- 2 => Syslog\n- 3 => SNMP Trap", "type":"integer", "example":1 }, "ProfileTypeName":{ "description":"Name of Notification Profile Type.", "type":"string", "example":"Email" }, "ProfileName":{ "description":"Name for the Notification Profile.", "type":"string", "example":"Generic Email" }, "ProfileDescription":{ "description":"Profile Description", "type":"string", "example":"This is the Generic Unified Assurance Profile for Email" }, "PrimaryEmailServer":{ "description":"FQDN of Primary Email Server", "type":"string", "example":"primary.server.com" }, "PrimaryEmailPort":{ "description":"Primary Email Server port", "type":"integer", "example":25 }, "PrimaryEmailTypeID":{ "description":"Primary Email Type ID", "type":"integer", "example":1 }, "PrimaryEmailUser":{ "description":"User for the Primary Email Server", "type":"string", "example":"primary@email.com" }, "PrimaryEmailPass":{ "description":"Password for the Primary Email Server user", "type":"string", "example":"xyzABC123@" }, "BackupEmailServer":{ "description":"FQDN of Backup Email Server", "type":"string", "example":"backup.server.com" }, "BackupEmailPort":{ "description":"Backup Email Server port", "type":"integer", "example":25 }, "BackupEmailTypeID":{ "description":"Backup Email Type ID", "type":"integer", "example":1 }, "BackupEmailUser":{ "description":"User for the Backup Email Server", "type":"string", "example":"backup@email.com" }, "BackupEmailPass":{ "description":"Password for the Backup Email Server user", "type":"string", "example":"password" }, "ConnectionSecurity":{ "description":"Email Connection Security Flag\n\nAllowed Values:\n- 0 => Plaintext/None\n- 1 => SSL (Secure on Connect)\n- 2 => TLS (Negotiated)", "type":"integer", "example":0 }, "SSLVerify":{ "description":"Flag to indicate whether SSL certificate authentication is needed", "type":"boolean", "example":"1" }, "Timeout":{ "description":"Timeout (in seconds) for Email server connection", "type":"integer", "example":30 }, "SyslogServers":{ "description":"FQDN of Syslog Servers. If more than one server, the value is presented in comma separated list.", "type":"string", "example":"", "nullable":true }, "SyslogPort":{ "description":"Syslog server port", "type":"integer", "example":80, "nullable":true }, "TrapServers":{ "description":"FQDN of Trap Servers. If more than one server, the value is presented in comma separated list.", "type":"string", "example":"", "nullable":true }, "TrapPort":{ "description":"Trap Servers port", "type":"integer", "example":"", "nullable":true } }, "type":"object" }, "notificationProfilesCreate":{ "properties":{ "ProfileTypeID":{ "description":"Profile Type ID\n\nAllowed values:\n- 1 => Email\n- 2 => Syslog\n- 3 => Trap", "type":"integer", "example":1 }, "ProfileTypeName":{ "description":"Profile Type Name\n\nAllowed values:\n- Email\n- Syslog\n- Trap", "type":"string", "example":"Email" }, "ProfileName":{ "description":"The notification profile name.\n
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Generic Email" }, "ProfileDescription":{ "description":"Profile Description", "type":"string", "example":"This is the Generic Unified Assurance Profile for Email" }, "PrimaryEmailServer":{ "description":"Primary Email Server. If ProfileTypeID is 1 (Email), PrimaryEmailServer is required.", "type":"string", "example":"primary.server.com" }, "PrimaryEmailPort":{ "description":"Primary Email Port. If ProfileTypeID is 1 (Email), PrimaryEmailPort is required.", "type":"integer", "example":25 }, "PrimaryEmailTypeID":{ "description":"Primary Email Type ID. If ProfileTypeID is 1 (Email), PrimaryEmailTypeID is required.", "type":"integer", "example":1 }, "PrimaryEmailUser":{ "description":"Primary Email User. If ProfileTypeID is 1 (Email), PrimaryEmailUser is required.", "type":"string", "example":"primary@email.com" }, "PrimaryEmailPass":{ "description":"Primary Email Password. If ProfileTypeID is 1 (Email), PrimaryEmailPass is required.", "type":"string", "example":"xyzABC123@" }, "BackupEmailServer":{ "description":"Backup Email Server. If not defined, the Backup value will be the same as the corresponding Primary value.", "type":"string", "example":"backup.server.com" }, "BackupEmailPort":{ "description":"Backup Email Port. If not defined, the Backup value will be the same as the corresponding Primary value.", "type":"integer", "example":25 }, "BackupEmailTypeID":{ "description":"Backup Email Type ID. If not defined, the Backup value will be the same as the corresponding Primary value.", "type":"integer", "example":1 }, "BackupEmailUser":{ "description":"Backup Email User. If not defined, the Backup value will be the same as the corresponding Primary value.", "type":"string", "example":"backup@email.com" }, "BackupEmailPass":{ "description":"Backup Email Password. If not defined, the Backup value will be the same as the corresponding Primary value.", "type":"string", "example":"password" }, "ConnectionSecurity":{ "description":"Email Connection Security Flag. If ProfileTypeID is 1 (Email), ConnectionSecurity is required.\n\nAllowed Values:\n- 0 => Plaintext/None\n- 1 => SSL (Secure on Connect)\n- 2 => TLS (Negotiated)", "type":"integer", "example":0 }, "SSLVerify":{ "description":"Email SSL Verification indicator. If ProfileTypeID is 1 (Email), SSLVerify is required.", "type":"boolean", "example":"1" }, "Timeout":{ "description":"Email Connection Timeout. If ProfileTypeID is 1 (Email), Timeout is required.", "type":"integer", "example":30 } } }, "notificationProfilesReadForSelect":{ "properties":{ "ProfileID":{ "description":"Id of the profile", "type":"integer", "example":"1" }, "ProfileName":{ "description":"Name of the profile", "type":"string", "example":"Generic Email" } }, "type":"object" }, "notificationTemplatesReadForSelect":{ "properties":{ "TemplateID":{ "description":"Id of the template", "type":"integer", "example":"1" }, "TemplateName":{ "description":"Name of the template", "type":"string", "example":"Generic Email" } }, "type":"object" }, "notificationTemplatesRead":{ "properties":{ "TemplateID":{ "description":"ID of Notification Template", "type":"integer", "example":1 }, "ProfileTypeID":{ "description":"Profile Type ID", "type":"integer", "example":1 }, "ProfileTypeName":{ "description":"Profile Type Name", "type":"string", "example":"Syslog" }, "TemplateName":{ "description":"Name of Notification Template", "type":"string", "example":"Template1" }, "TemplateDescription":{ "description":"Template Description", "type":"string", "example":"This is an example Template Description" }, "EmailFrom":{ "description":"Sender email address", "type":"string", "example":"example@example.com", "nullable":true }, "EmailSubject":{ "description":"Email subject", "type":"string", "example":"Unified Assurance Report: 1234", "nullable":true }, "EmailBody":{ "description":"Email message body", "type":"string", "example":"Attached is a report from Unified Assurance.", "nullable":true }, "Syslog":{ "description":"Syslog log message template", "type":"string", "example":"$DATE_EPOCH|$MESSAGE|$DNS|$IP|$INSTANCE|$VALUE|$UTIL|$TYPE|$POLLER|$SAMPLERATE|$COMPARE|$STATUS|$METRICID|$STATE|$DEVICENAME", "nullable":true }, "EnterpriseID":{ "description":"Enterprise OID", "type":"string", "example":"", "nullable":true }, "SNMPVersion":{ "description":"SNMP Version", "type":"integer", "example":"", "nullable":true }, "Trap_OID0":{ "description":"Trap OID 0", "type":"string", "example":"", "nullable":true }, "Trap_Value0":{ "description":"Trap Value 0", "type":"string", "example":"", "nullable":true }, "Trap_OID1":{ "description":"Trap OID 1", "type":"string", "example":"", "nullable":true }, "Trap_Value1":{ "description":"Trap Value 1", "type":"string", "example":"", "nullable":true }, "Trap_OID2":{ "description":"Trap OID 2", "type":"string", "example":"", "nullable":true }, "Trap_Value2":{ "description":"Trap Value 2", "type":"string", "example":"", "nullable":true }, "Trap_OID3":{ "description":"Trap OID 3", "type":"string", "example":"", "nullable":true }, "Trap_Value3":{ "description":"Trap Value 3", "type":"string", "example":"", "nullable":true }, "Trap_OID4":{ "description":"Trap OID 4", "type":"string", "example":"", "nullable":true }, "Trap_Value4":{ "description":"Trap Value 4", "type":"string", "example":"", "nullable":true }, "Trap_OID5":{ "description":"Trap OID 5", "type":"string", "example":"", "nullable":true }, "Trap_Value5":{ "description":"Trap Value 5", "type":"string", "example":"", "nullable":true }, "Trap_OID6":{ "description":"Trap OID 6", "type":"string", "example":"", "nullable":true }, "Trap_Value6":{ "description":"Trap Value 6", "type":"string", "example":"", "nullable":true }, "Trap_OID7":{ "description":"Trap OID 7", "type":"string", "example":"", "nullable":true }, "Trap_Value7":{ "description":"Trap Value 7", "type":"string", "example":"", "nullable":true }, "Trap_OID8":{ "description":"Trap OID 8", "type":"string", "example":"", "nullable":true }, "Trap_Value8":{ "description":"Trap Value 8", "type":"string", "example":"", "nullable":true }, "Trap_OID9":{ "description":"Trap OID 9", "type":"string", "example":"", "nullable":true }, "Trap_Value9":{ "description":"Trap Value 9", "type":"string", "example":"", "nullable":true } }, "type":"object" }, "notificationTemplatesCreate":{ "properties":{ "ProfileTypeID":{ "description":"Profile Type ID", "type":"integer", "example":1 }, "ProfileTypeName":{ "description":"Profile Type Name", "type":"string", "example":"Syslog" }, "TemplateName":{ "description":"The template name.\n
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Template1" }, "TemplateDescription":{ "description":"Template Description", "type":"string", "example":"This is an example Template Description" }, "EmailFrom":{ "description":"Sender email address", "type":"string", "example":"example@example.com" }, "EmailSubject":{ "description":"Email subject", "type":"string", "example":"Example Email Subject" }, "EmailBody":{ "description":"Email message body", "type":"string", "example":"Example Email Message Body" } }, "type":"object" }, "packageDepotsRead":{ "properties":{ "DepotID":{ "description":"Depot ID", "type":"integer", "example":"3" }, "DepotName":{ "description":"Depot Name", "type":"string", "example":"stable" }, "DepotType":{ "description":"Depot Type ID\n\nAllowed Values:\n- 2 => Remote URL\n- 3 => Local Filesystem", "type":"integer", "example":"2" }, "DepotLocation":{ "description":"The location of the depot. When DepotType is 3, this should be an absolute path on the local file system. When DepotType is 2, this should be a URL.", "type":"string", "example":"/api" }, "StatusID":{ "description":"The depot status ID. Either 0 (disabled) or 1 (enabled).", "type":"integer", "example":"1" }, "Status":{ "description":"Value of the Status ID", "type":"string", "example":"Enabled" }, "StatusIcon":{ "description":"Status Icon", "type":"string", "example":"OrbGreen.png" }, "DepotTypeName":{ "description":"Name of the Depot Type \n\nPossible values: \n- Remote URL (Depot Type=2)\n- Local Path (Depot Type=3)", "type":"string", "example":"Remote URL" } }, "type":"object" }, "packageDepots":{ "properties":{ "DepotName":{ "description":"The depot name.\n
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"stable" }, "DepotType":{ "$ref":"#/components/schemas/packageDepotsRead/properties/DepotType" }, "DepotLocation":{ "$ref":"#/components/schemas/packageDepotsRead/properties/DepotLocation" }, "StatusID":{ "$ref":"#/components/schemas/packageDepotsRead/properties/StatusID" } }, "type":"object" }, "packageDepotsReadForSelect":{ "properties":{ "DepotID":{ "$ref":"#/components/schemas/packageDepotsRead/properties/DepotID" }, "DepotName":{ "$ref":"#/components/schemas/packageDepotsRead/properties/DepotName" }, "DepotType":{ "$ref":"#/components/schemas/packageDepotsRead/properties/DepotType" }, "DepotLocation":{ "$ref":"#/components/schemas/packageDepotsRead/properties/DepotLocation" } }, "type":"object" }, "reportReportsRead":{ "properties":{ "ReportID":{ "description":"Report ID", "type":"integer", "example":"1000" }, "ReportName":{ "description":"The title to identify the report at a glance.", "type":"string", "example":"Sample" }, "RenderTimeout":{ "description":"The number of seconds to allow the report to render before capturing the results for the report.", "type":"integer", "example":"3" }, "RunAsUserID":{ "description":"The ID of the Unified Assurance user that will run the report. The user's permissions will be used to determine what data can be included.", "type":"integer", "example":"1" }, "UserName":{ "description":"The name of the Unified Assurance user that will run the report.", "type":"string", "example":"admin" }, "RunAsUserGroupID":{ "description":"The Unified Assurance user group that will run the report. The user group's permissions will be used to determine what data can be included.", "type":"integer", "example":"1" }, "Recipients":{ "description":"Email addresses the report notification should be sent to when the report is run.", "type":"string", "example":"example@example.com" }, "StatusID":{ "description":"The report status ID, indicating whether the report is being run (enabled,1), or not (disabled, 0.", "type":"integer", "example":"1" }, "OwnerUserID":{ "description":"The ID of the user that owns the report. If an associated Profile enables archiving, the archived file will also be owned by this user. This can never be an externally-authenticated transient user. 0 means it is public to all users in the owning group.", "type":"integer", "example":"0" }, "OwnerUserGroupID":{ "description":"The user group that owns the report. If an associated report Profile has archiving enabled, the archived file will also be owned by this group.", "type":"integer", "example":"0" }, "Source":{ "description":"The source of the report.\n
    Allowed Values:\n
    • OpenSearch for OpenSearch dashboards.
      • \n
    • Unified Assurance for everything else.
      • \n
    ", "type":"string", "example":"OpenSearch" }, "DashboardID":{ "description":"The Unified Assurance dashboard included in the report. Used when Source is set to Unified Assurance.", "type":"integer", "example":"28" }, "DashboardUUID":{ "description":"The OpenSearch dashboard included in the report. Used when Source is set to OpenSearch.", "type":"string", "example":"5f59d990-3d3f-11eb-bc2c-c5758316d788" }, "DashboardName":{ "description":"The name of the dashboard included in the report.", "type":"string", "example":"Adhoc Event Dashboard" }, "TimeRange":{ "description":"The shorthand string for the time range used for the OpenSearch dashboard report. Includes the start and end times in RFC3339 or relative time literal format. Only used when Source is set to OpenSearch.", "type":"string", "example":"now-24h..now" }, "ReportProfileID":{ "description":"The report profile that provides the generic configuration of the report.", "type":"integer", "example":"2" }, "ReportProfileName":{ "description":"Report profile that provides the generic configuration of the report", "type":"string", "example":"Sample Attachment Profile" }, "BrokerComponentID":{ "description":"Broker component that will carry out generation of the report", "type":"integer", "example":"55" }, "FullName":{ "description":"User Group name", "type":"string", "example":"Administrator" }, "Status":{ "description":"The state of the report.", "type":"string", "example":"Enabled" }, "StatusIcon":{ "description":"Status Icon", "type":"string", "example":"OrbGreen.png" }, "Footer":{ "description":"Determine what extra information is added to the end of the report. \n
    Allowed Values:\n
    • none adds nothing.
      • \n
    • basic adds the date, time, and user the report was run as.
      • \n
    • enhanced adds the basic footer and any parameters that were used to create the report.
    ", "type":"string", "example":"basic" }, "State":{ "description":"State", "type":"integer", "example":"0" }, "LastRun":{ "description":"Last time the report generator was run.", "type":"string", "example":"2022-11-22 11:43:00" }, "AppendDateTime":{ "description":"Flag to indicate if the date and time should be appended to the report name.", "type":"integer", "example":"1" }, "ReportParameters":{ "description":"Parameters to pass to the portal", "type":"string", "example":"DeviceID=1" }, "Minutes":{ "description":"The minutes when the report will be run. Valid entries are \"*\" which means every minute, numbers between 0 and 59 to run at that minute, or \"*/\" can be used to indicate \"Every number of minutes\".", "type":"string", "example":"0" }, "Hours":{ "description":"The hours when the report will be run. Valid entries are \"*\" which means every hour, numbers between 0 and 23 to run at that hour, or \"*/\" can be used to indicate \"Every number of hours\".", "type":"string", "example":"0" }, "Days":{ "description":"The day of the month when the report will be run. Valid entries are \"*\" which means every day, numbers between 1 and 31 to run on that day of the month, or \"*/\" can be used to indicate \"Every number of days\".", "type":"string", "example":"*" }, "Months":{ "description":"The month when the report will be run. Valid entries are \"*\" which means every month, numbers between 1 and 12 to run at that minute, or \"*/\" can be used to indicate \"Every number of months\".", "type":"string", "example":"*" }, "WeekDays":{ "description":"The day of the week when the report will be run. Valid entries are \"*\" which means every day of the week, numbers between 0 and 7 (0/7 = Sunday, 1 = Monday, 2 = Tuesday, 3 = Wednesday, 4 = Thursday, 5 = Friday, 6 = Saturday), or \"*/\" can be used to indicate \"Every number of days\".", "type":"string", "example":"*" }, "Extension":{ "description":"Report output format\nAllowed Values:\n- png\n- pdf\n- csv\n- xlsx\n- xls\n- html", "type":"string", "example":"pdf" }, "Viewers":{ "description":"The user groups that will also have access to the report.", "type":"array", "items":{ "type":"object", "properties":{ "UserGroupID":{ "description":"User Group ID", "type":"integer", "example":"0" }, "UserGroupName":{ "description":"User Group Name", "type":"string", "example":"[Public to All Groups]" } } } } }, "type":"object" }, "reportReports":{ "properties":{ "ReportName":{ "description":"The report name.\n
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"New Report" }, "AppendDateTime":{ "$ref":"#/components/schemas/reportReportsRead/properties/AppendDateTime" }, "ReportProfileID":{ "$ref":"#/components/schemas/reportReportsRead/properties/ReportProfileID" }, "Source":{ "$ref":"#/components/schemas/reportReportsRead/properties/Source" }, "DashboardID":{ "$ref":"#/components/schemas/reportReportsRead/properties/DashboardID" }, "DashboardUUID":{ "$ref":"#/components/schemas/reportReportsRead/properties/DashboardUUID" }, "TimeRange":{ "$ref":"#/components/schemas/reportReportsRead/properties/TimeRange" }, "ReportParameters":{ "$ref":"#/components/schemas/reportReportsRead/properties/ReportParameters" }, "Recipients":{ "$ref":"#/components/schemas/reportReportsRead/properties/Recipients" }, "Footer":{ "$ref":"#/components/schemas/reportReportsRead/properties/Footer" }, "RenderTimeout":{ "$ref":"#/components/schemas/reportReportsRead/properties/RenderTimeout" }, "StatusID":{ "$ref":"#/components/schemas/reportReportsRead/properties/StatusID" }, "RunAsUserGroupID":{ "$ref":"#/components/schemas/reportReportsRead/properties/RunAsUserGroupID" }, "RunAsUserID":{ "$ref":"#/components/schemas/reportReportsRead/properties/RunAsUserID" }, "OwnerUserID":{ "$ref":"#/components/schemas/reportReportsRead/properties/OwnerUserID" }, "OwnerUserGroupID":{ "$ref":"#/components/schemas/reportReportsRead/properties/OwnerUserGroupID" }, "Viewers":{ "description":"The user groups that will also have access to the report.", "type":"array", "items":{ }, "example":[ 0 ] }, "Minutes":{ "$ref":"#/components/schemas/reportReportsRead/properties/Minutes" }, "Hours":{ "$ref":"#/components/schemas/reportReportsRead/properties/Hours" }, "Days":{ "$ref":"#/components/schemas/reportReportsRead/properties/Days" }, "Months":{ "$ref":"#/components/schemas/reportReportsRead/properties/Months" }, "WeekDays":{ "$ref":"#/components/schemas/reportReportsRead/properties/WeekDays" } }, "type":"object" }, "reportReportsReadForSelect":{ "properties":{ "ReportID":{ "$ref":"#/components/schemas/reportReportsRead/properties/ReportID" }, "ReportName":{ "$ref":"#/components/schemas/reportReportsRead/properties/ReportName" } }, "type":"object" }, "reportOpenSearchReadForSelect":{ "properties":{ "DashboardID":{ "description":"The UUID of the OpenSearch dashboard.", "type":"string", "example":"5f59d990-3d3f-11eb-bc2c-c5758316d788" }, "DashboardName":{ "description":"The name of the OpenSearch dashboard.", "type":"string", "example":"[Metrics] Network Performance Dashboard" } }, "type":"object" }, "reportProfilesRead":{ "properties":{ "ReportProfileID":{ "description":"Report Profile ID", "type":"integer", "example":"2" }, "ReportProfileName":{ "description":"The identifier for the profile.", "type":"string", "example":"Sample Attachment Profile" }, "NotificationProfileID":{ "description":"The profile ID used to notify the recipients that the scheduled report is ready.", "type":"integer", "example":"1" }, "NotificationProfileName":{ "description":"The profile name used to notify the recipients that the scheduled report is ready.", "type":"string", "example":"Generic Email" }, "NotificationTemplateID":{ "description":"The template ID used to notify the recipients that the scheduled report is ready.", "type":"integer", "example":"3" }, "NotificationTemplateName":{ "description":"The template used to notify the recipients that the scheduled report is ready.", "type":"string", "example":"Unified Assurance Report - Attachment" }, "Archive":{ "description":"Checkbox to indicate whether the report results will be archived in the file repository or not.\n\nAllowed Values:\n- 0 => Disabled\n- 1 => Enabled", "type":"integer", "example":"1" }, "ArchiveDisplay":{ "description":"Display of the archived reports.\n\nAllowed values:\n- Yes\n- No", "type":"string", "example":"Yes" }, "Format":{ "description":"The type of output the report will produce.\n\nAllowed Values:\n- PNG\n- PDF\n- Data Export", "type":"string", "example":"PDF" }, "ArchiveExpireDays":{ "description":"Number of days to keep archived reports before they expire. It is Required when Archive is 1.", "type":"integer", "example":"30" }, "Height":{ "description":"Height of the output in pixels", "type":"integer", "example":"1800" }, "Width":{ "description":"Width of the output in pixels", "type":"integer", "example":"1024" }, "Zoom":{ "description":"PDF Zoom level needed to scale content", "type":"number", "example":"1" }, "Orientation":{ "description":"Page orientation used by PDF\n\nAllowed Values:\n- Landscape\n- Portrait", "type":"string", "example":"Landscape" }, "PageSize":{ "description":"If Report Format is set to \"PDF\", the page size for the PDF to use.\n\nAllowed Values:\n- A4\n- Letter\n- Manual", "type":"string", "example":"Letter" }, "ManualPageSize":{ "description":"If Page Size is set to \"Manual\", a string explaining the page size to use in the PDF. Examples are \"5in*7.5in\", \"10cm*20cm\", \"A4\", \"Letter\".", "type":"string", "example":"Letter" }, "Autosize":{ "description":"Flag indicating whether the report runner should calculate width and height for the image or pdf\n\nAllowed Values:\n- 0 => Use user defined configuration\n- 1 => Autosize", "type":"integer", "example":"1" }, "ReportFormat":{ "description":"The type of output the report will produce.\n\nAllowed Values:\n- PNG\n- PDF\n- Data Export", "type":"string", "example":"PDF" }, "DataFormat":{ "description":"If Report Format is set to \"Data Export\", the type of file that is generated.\n\nAllowed Values:\n- Excel 2007+(*.xlsx)\n- Excel 97-2003(*.xls)\n- CSV\n- Hypertext(*.html)\n- PDF", "type":"string", "example":"Excel 2007+(*.xlsx)" } }, "type":"object" }, "reportProfiles":{ "properties":{ "ReportProfileName":{ "description":"The report profile name.\n
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Generic Email" }, "NotificationProfileID":{ "$ref":"#/components/schemas/reportProfilesRead/properties/NotificationProfileID" }, "NotificationTemplateID":{ "$ref":"#/components/schemas/reportProfilesRead/properties/NotificationTemplateID" }, "Archive":{ "$ref":"#/components/schemas/reportProfilesRead/properties/Archive" }, "ArchiveExpireDays":{ "$ref":"#/components/schemas/reportProfilesRead/properties/ArchiveExpireDays" }, "ReportFormat":{ "$ref":"#/components/schemas/reportProfilesRead/properties/ReportFormat" }, "Autosize":{ "$ref":"#/components/schemas/reportProfilesRead/properties/Autosize" }, "Width":{ "$ref":"#/components/schemas/reportProfilesRead/properties/Width" }, "Height":{ "$ref":"#/components/schemas/reportProfilesRead/properties/Height" }, "Zoom":{ "$ref":"#/components/schemas/reportProfilesRead/properties/Zoom" }, "DataFormat":{ "$ref":"#/components/schemas/reportProfilesRead/properties/DataFormat" }, "Orientation":{ "$ref":"#/components/schemas/reportProfilesRead/properties/Orientation" }, "PageSize":{ "$ref":"#/components/schemas/reportProfilesRead/properties/PageSize" }, "ManualPageSize":{ "$ref":"#/components/schemas/reportProfilesRead/properties/ManualPageSize" } }, "type":"object" }, "reportProfilesReadForSelect":{ "properties":{ "ReportProfileID":{ "$ref":"#/components/schemas/reportProfilesRead/properties/ReportProfileID" }, "ReportProfileName":{ "$ref":"#/components/schemas/reportProfilesRead/properties/ReportProfileName" } }, "type":"object" }, "ruleRulesRead":{ "properties":{ "PathID":{ "description":"Path ID", "type":"string", "example":"id-core" }, "PathName":{ "description":"Path Name", "type":"string", "example":"core" }, "Info":{ "description":"Repository Name", "type":"string", "example":"Core Rules" }, "Checkouts":{ "description":"Checkouts", "type":"integer", "example":"1" }, "LastRevision":{ "description":"Last Revision", "type":"integer", "example":"8" }, "ModificationTime":{ "description":"Modification Time", "type":"string", "example":"2023-08-31 07:00:35" }, "icon":{ "description":"Image icon path", "type":"string", "example":"/resources/assure1/images/icons/silk/basket.png" } }, "type":"object" }, "ruleRulesExecuteCheckSyntax":{ "properties":{ "Content":{ "description":"The Perl based processing logic of the rules", "type":"string" } } }, "ruleRulesCreateBranch":{ "properties":{ "CommitLog":{ "description":"Text to enter as commit log for the change", "type":"string", "example":"Default Commit Message" }, "PathName":{ "description":"Path to file", "type":"string", "example":"RO_LOCKED-test" }, "BranchDescription":{ "description":"Description of branch", "type":"string", "example":"Branch of RO_LOCKED" }, "ClonedPath":{ "description":"Path to cloned file", "type":"string", "example":"id-core/RO_LOCKED" } }, "type":"object" }, "ruleRules":{ "properties":{ "CommitLog":{ "description":"Text to enter as commit log for the change", "type":"string", "example":"Default Commit Message" }, "PathName":{ "description":"Path to file", "type":"string", "example":"example_file" }, "ClonedPath":{ "description":"Path to cloned file", "type":"string", "example":"id-core/default/example_file" }, "RuleText":{ "description":"Content of the rule", "type":"string", "example":"Testing" } }, "type":"object" }, "ruleRulesReadDiff":{ "properties":{ "fromFile":{ "description":"The content of the file", "type":"string", "example":"/n=head1 NAME/n/n Auto Discovery Post Discovery Rules/n" }, "toFile":{ "description":"The content of the file", "type":"string", "example":"/n=head1 NAME/n/n Auto Discovery Post Discovery Rules/n" } } }, "ruleRulesreadRevisionHistory":{ "properties":{ "Node":{ "description":"User Group ID parent node of Users", "type":"string", "example":"core/RO_LOCKED/example/auto/base.rules" }, "RevisionID":{ "description":"Revision ID", "type":"integer", "example":"3" }, "RevisionName":{ "description":"Revision Name", "type":"string", "example":"r3 [2023-08-04] Updates for package core-rules-6.0.3.0.0.53(1/19)" } }, "type":"object" }, "ruleRulesExecuteCreateFolder":{ "properties":{ "CommitLog":{ "description":"Text to enter as commit log for the change", "type":"string", "example":"Default Commit Message" }, "FolderName":{ "description":"Folder Name", "type":"string", "example":"Example_Folder" } }, "type":"object" }, "ruleRulesCreateUploadFile":{ "properties":{ "CommitLog":{ "description":"Text to enter as commit log for the change", "type":"string", "example":"Default Commit Message" }, "PathName":{ "description":"Path to file", "type":"string", "example":"base.rules" }, "UploadFile":{ "description":"File to upload", "type":"string", "example":"(binary)" } }, "type":"object" }, "ruleRulesExecuteRevert":{ "properties":{ "FileName":{ "description":"File Name of new file (appended to Path)", "type":"string", "example":"core/default/example_file/testing" }, "RevertRevision":{ "description":"File revision number to revert the file to", "type":"string", "example":15 } }, "type":"object" }, "ruleRulesExecuteDownload":{ "properties":{ "file":{ "description":"File and location within repo for file download", "type":"string", "example":"core/RO_LOCKED/collection/discovery/auto/base.rules" } } }, "ruleBranchesReadForSelect":{ "properties":{ "BranchPath":{ "description":"Branch Path", "type":"string", "example":"config/default" }, "BranchValue":{ "description":"Branch Value", "type":"string", "example":"config/default" } }, "type":"object" }, "topologyMenusRead_byID":{ "properties":{ "TopologyMenuID":{ "description":"Topology Menu ID", "type":"integer", "example":"2" }, "TopologyMenuName":{ "description":"Topology Menu Name", "type":"string", "example":"Default Topology Tools" }, "UserGroupID":{ "description":"User Group ID", "type":"object", "properties":{ "id":{ "description":"ID of the User Group", "type":"integer", "example":"1" }, "name":{ "description":"User Group Name", "type":"string", "example":"Administrators" } } }, "ParentMenuID":{ "description":"Parent Menu ID", "type":"integer", "example":"1" }, "TreeDepth":{ "description":"Indicator or how many levels deep the new parent menu is. TreeDepth is different than depth. TreeDepth is the number of menus above the current menu. This means TreeDepth will always be depth - 1.", "type":"integer" }, "Tools":{ "description":"List of Tool IDs", "type":"array", "items":{ "type":"object", "properties":{ "ToolID":{ "description":"Tool ID", "type":"integer", "example":"1" }, "ToolName":{ "description":"Tool Name", "type":"string", "example":"Device Overview" } } }, "example":[ { "ToolID":"1", "ToolName":"Device Overview" }, { "ToolID":"2", "ToolName":"Events" } ] } }, "type":"object" }, "topologyMenusRead":{ "properties":{ "TopologyMenuID":{ "description":"Topology Menu ID", "type":"integer", "example":1 }, "DisplayName":{ "description":"Display Name", "type":"string", "example":"Root" }, "id":{ "description":"Topology menu ID", "type":"integer", "example":1 }, "TreeDepth":{ "description":"Indicator or how many levels deep the new parent menu is. TreeDepth is different than depth. TreeDepth is the number of menus above the current menu. This means TreeDepth will always be depth - 1.", "type":"integer", "example":1 }, "text":{ "description":"Topology menu name", "type":"string", "example":"Root" }, "leaf":{ "description":"Flag to indicate if the menu is the end of the tree (value = true) or the menu has children (value = false)", "type":"boolean", "example":false }, "cls":{ "description":"CSS class to indicate if this is a leaf or not", "type":"string", "example":"folder" }, "qtip":{ "description":"Topology Menu Name", "type":"string", "example":"Root" }, "expanded":{ "description":"Expansion of Root Directory", "type":"boolean", "example":true }, "data":{ "description":"Records of data", "type":"array", "items":{ "type":"object", "properties":{ "TopologyMenuID":{ "$ref":"#/components/schemas/topologyMenusRead_byID/properties/TopologyMenuID" }, "TopologyMenuName":{ "$ref":"#/components/schemas/topologyMenusRead_byID/properties/TopologyMenuName" }, "DisplayName":{ "$ref":"#/components/schemas/topologyMenusRead/properties/DisplayName" }, "ParentMenuID":{ "$ref":"#/components/schemas/topologyMenusRead_byID/properties/ParentMenuID" }, "qtip":{ "$ref":"#/components/schemas/topologyMenusRead/properties/qtip" }, "cls":{ "description":"Menu type", "type":"string", "example":"folder" } } }, "example":[ { "TopologyMenuID":"2", "TopologyMenuName":"Default Topology Tools", "DisplayName":"Default Topology Tools", "ParentMenuID\"":"1", "qtip":"Default Topology Tools", "cls":"folder" }, { "TopologyMenuID":"1001", "TopologyMenuName":"Sample Topology Tools", "DisplayName":"Sample Topology Tools", "ParentMenuID":"1", "qtip":"Sample Topology Tools", "cls":"folder" } ] } }, "type":"object" }, "topologyMenus":{ "properties":{ "TopologyMenuName":{ "description":"The topology menu name.\n
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Default Topology Tools" }, "ParentMenuID":{ "$ref":"#/components/schemas/topologyMenusRead_byID/properties/ParentMenuID" }, "Tools":{ "description":"List of Tool IDs", "type":"array", "items":{ "type":"integer" }, "example":[ 1, 2, 3, 4, 5 ] } }, "type":"object" }, "topologyMenusReadForSelect":{ "properties":{ "TopologyMenuID":{ "$ref":"#/components/schemas/topologyMenusRead_byID/properties/TopologyMenuID" }, "TopologyMenuName":{ "$ref":"#/components/schemas/topologyMenusRead_byID/properties/TopologyMenuName" } }, "type":"object" }, "topologyMenusReadForMenu":{ "properties":{ "ToolID":{ "$ref":"#/components/schemas/topologyToolsRead/properties/ToolID" }, "text":{ "$ref":"#/components/schemas/topologyToolsRead/properties/ToolName" }, "ToolName":{ "$ref":"#/components/schemas/topologyToolsRead/properties/ToolName" }, "ToolTypeName":{ "$ref":"#/components/schemas/topologyToolsRead/properties/ToolTypeName" }, "Icon":{ "$ref":"#/components/schemas/topologyToolsRead/properties/Icon" }, "ToolPath":{ "$ref":"#/components/schemas/topologyToolsRead/properties/ToolPath" }, "ToolPathTypeName":{ "$ref":"#/components/schemas/topologyToolsRead/properties/ToolPathTypeName" }, "ToolTarget":{ "$ref":"#/components/schemas/topologyToolsRead/properties/ToolTarget" }, "Width":{ "$ref":"#/components/schemas/topologyToolsRead/properties/Width" }, "Height":{ "$ref":"#/components/schemas/topologyToolsRead/properties/Height" } }, "example":[ { "ToolI":"1", "text":"Device Overview", "ToolName":"Device Overview", "ToolTypeName":"View", "icon":"/resources/assure1/images/icons/fugue/heart--exclamation.png", "ToolPath":"dashboard/Device%20Overview?DeviceName=&FilterType=DeviceName&FilterValue=&DeviceZoneID=", "ToolPathTypeName":"Internal", "ToolTarget":"window", "Width":"80", "Height":"80" }, { "ToolID":"2", "text":"Events", "ToolName":"Events", "ToolTypeName":"View", "icon":"/resources/assure1/images/icons/fugue/funnel--exclamation.png", "ToolPath":"event/events/EventsGrid?FilterType=DeviceName&FilterValue=&DeviceZoneID=", "ToolPathTypeName":"Internal", "ToolTarget":"window", "Width":"80", "Height":"80" }, { "ToolID":"3", "text":"Device Availability", "ToolName":"Device Availability", "ToolTypeName":"View", "icon":"/resources/assure1/images/icons/silk/brick_go.png", "ToolPath":"metric/availabilityData?DeviceName=&TimeRange=now-24h..now&DeviceZoneID=", "ToolPathTypeName":"Internal", "ToolTarget":"window", "Width":"80", "Height":"80" } ], "type":"object" }, "topologyMenusReadForTreeNode":{ "properties":{ "TopologyMenuID":{ "$ref":"#/components/schemas/topologyMenusRead/properties/TopologyMenuID" }, "TopologyMenuName":{ "$ref":"#/components/schemas/topologyMenusRead/properties/DisplayName" }, "leaf":{ "description":"Leaf Node of the tree", "type":"boolean", "example":false }, "iconCls":{ "description":"CSS class for icons.", "type":"string", "example":"x-tree-icon-parent" } }, "type":"object" }, "topologyMenusReadForTreeID":{ "properties":{ "TopologyMenuID":{ "$ref":"#/components/schemas/topologyMenusRead/properties/TopologyMenuID" }, "TopologyMenuName":{ "$ref":"#/components/schemas/topologyMenusRead/properties/DisplayName" }, "Lft":{ "description":"Index of the tree menu's left edge", "type":"integer", "example":1 }, "Rgt":{ "description":"Index of the tree menu's right edge", "type":"integer", "example":2 }, "UserGroupID":{ "description":"User group ID", "type":"integer" }, "UserGroupName":{ "description":"User group name", "type":"string" }, "path":{ "description":"The path to this menu starting with the root.", "type":"string" }, "depth":{ "description":"Indicator or how many levels deep this menu is. The root will always be 1", "type":"integer" }, "expanded":{ "description":"Indicates if the menu should be displayed expanded or collapsed.", "type":"boolean" }, "data":{ "description":"Contains the next level of data in the same format as this one.", "type":"object" } }, "type":"object" }, "topologyNetworkDetailsReadDeviceInfo":{ "type":"object", "properties":{ "Name":{ "description":"The name of the property.", "type":"string" }, "Value":{ "description":"The value of the property.", "type":"string" } } }, "topologyNetworkDetailsRead":{ "properties":{ "Index":{ "description":"Index", "type":"integer", "example":40 }, "Speed":{ "description":"Speed", "type":"integer", "example":"10000000000" }, "Name":{ "description":"Interface Name", "type":"string", "example":"cali5aca7483512" }, "Description":{ "description":"Description about the name", "type":"string", "example":"cali5aca7483512" }, "Alias":{ "description":"Alias", "type":"string", "example":null, "nullable":true }, "MACAddress":{ "description":"MAC Address", "type":"string", "example":"EE:EE:EE:EE:EE:EE" }, "Type":{ "description":"Network type", "type":"string", "example":"ethernetCsmacd" }, "DevId":{ "description":"Device ID", "type":"integer", "example":9 }, "IPAddress":{ "description":"IP Address", "type":"string", "example":"127.0.0.1" }, "IPv6Address":{ "description":"IPv6Address", "type":"string", "example":"::1" }, "IntOper":{ "description":"Operator", "type":"string", "example":"Up" }, "IntOperIcon":{ "description":"Operator Icon", "type":"string", "example":"fa fa-circle green" }, "TrunkAdmin":{ "description":"Trunk Admin", "type":"string", "example":"N/A" }, "TrunkAdminIcon":{ "description":"Trunk Admin Icon", "type":"string", "example":"fa fa-circle gray" }, "TrunkOperStatus":{ "description":"Trunk Oper Status", "type":"string", "example":"N/A" }, "TrunkOperIcon":{ "description":"Trunk Oper Icon", "type":"string", "example":"fa fa-circle gray" } }, "type":"object" }, "topologyNetworkDetailsReadSummary":{ "properties":{ "DeviceID":{ "description":"Device ID", "type":"integer", "example":9 }, "Interfaces":{ "description":"Interfaces", "type":"integer", "example":28 }, "IPRoutes":{ "description":"IP Routes", "type":"integer", "example":27 }, "ARPTable":{ "description":"ARP Table", "type":"integer", "example":59 }, "MACAddresses":{ "description":"MAC Addresses", "type":"integer", "example":0 }, "VLANs":{ "description":"VLANs", "type":"integer", "example":0 }, "Neighbors":{ "description":"Neighbors", "type":"integer", "example":0 } }, "type":"object" }, "topologyToolsRead":{ "properties":{ "ContextElement":{ "description":"The graph elements that the tool is available for.
    Allowed values are:\n
    • Edge
    • Vertex
    \nWhen ContextElement, ContextEdgeType, and ContextVertexType are all unset, the tool is available in all topology graph contexts. When any of the context properties are set, the tool is available only in the specified context. The setting in ContextElement overrides any more specific settings in the other two context properties. This means that if ContextElement is set to Edge, the tool is available for all edges, regardless of what is set in ContextEdgeType.", "type":"string", "example":"Edge" }, "ContextEdgeType":{ "description":"The edge type that the tool is available for.\nWhen ContextElement, ContextEdgeType, and ContextVertexType are all unset, the tool is available in all topology graph contexts. When any of the context properties are set, the tool is available only in the specified context.", "type":"string", "example":"ConnectsInterface" }, "ContextVertexType":{ "description":"The vertex type that the tool is available for.\nWhen ContextElement, ContextEdgeType, and ContextVertexType are all unset, the tool is available in all topology graph contexts. When any of the context properties are set, the tool is available only in the specified context.", "type":"string", "example":"Device" }, "ToolID":{ "description":"The tool ID.", "type":"integer", "example":"1" }, "ToolName":{ "description":"The name of the tool.", "type":"string", "example":"Device Overview" }, "ToolTypeName":{ "description":"The name of the tool type. For topology tools, this is always View.", "type":"string", "example":"View" }, "Icon":{ "description":"The icon used for the tool in menus.", "type":"string", "example":"fugue/heart--exclamation.png" }, "Width":{ "description":"Used when toolTarget is set to window. The width of the pop-up window. Any value between 10 and 90 is treated as a percentage of the overall browser width. Any value greater than 100 is treated as an absolute pixel value.", "type":"integer", "example":"80" }, "Height":{ "description":"Used when toolTarget is set to window. The height of the pop-up window. Any value between 10 and 90 is treated as a percentage of the overall browser height. Any value greater than 100 is treated as an absolute pixel value.", "type":"integer", "example":"80" }, "ToolTypeID":{ "description":"The ID of the tool type. For topology tools, this is always 1 for the View type.", "type":"integer", "example":"1" }, "ToolPath":{ "description":"The path to the web page to open, or script or function to run, depending on the value of Path Type.
    \nIf the value starts with a string and ://, such as https://, this is an absolute path. Otherwise, the path is relative to the $A1BASEDIR/www/tools/topology/ directory.\n
    You can use tokens in the path in the format <Property> to represent object properties. When the tool is run, tokens are replaced with actual values. For example, <DeviceID> is replaced with the value from the object's DeviceID property. Common tokens include:\n
      \n
    • <DeviceID>
      • \n
    • <ObjectID>
      • \n
    • <OwnerUserID>
      • \n
    • <OwnerUserGroupID>
      • \n
    ", "type":"string", "example":"dashboard/Device%20Overview?DeviceName=&FilterType=DeviceName&FilterValue=&DeviceZoneID=" }, "ToolPathTypeID":{ "description":"The ID of the tool path type.
    Possible values are:\n
      \n
    • 1: Local
      • \n
    • 2: Internal
      • \n
    • 3: Hybrid
      • \n
    • 4: Remote
      • \n
    • 5: Function
      • \n
    ", "type":"integer", "example":"2" }, "ToolPathTypeName":{ "description":"The name of the tool path type.", "type":"string", "example":"Internal" }, "ToolTarget":{ "description":"How the tool opens new pages.
    Possible values are:\n
      \n
    • window: Opens in a pop-up window.
      • \n
    • currenttab: Opens in the current browser tab.
      • \n
    • newtab: Opens in a new browser tab.
      • \n
    ", "type":"string", "example":"window" }, "ToolTargetName":{ "description":"The name of the tool target.", "type":"string", "example":"window" }, "ObjectTypeID":{ "description":"The object type ID for the tool.", "type":"integer", "example":"1" } }, "type":"object" }, "topologyTools":{ "properties":{ "ContextElement":{ "$ref":"#/components/schemas/topologyToolsRead/properties/ContextElement" }, "ContextEdgeType":{ "$ref":"#/components/schemas/topologyToolsRead/properties/ContextEdgeType" }, "ContextVertexType":{ "$ref":"#/components/schemas/topologyToolsRead/properties/ContextVertexType" }, "ToolName":{ "description":"The topology tool name.\n
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Device Overview" }, "Icon":{ "$ref":"#/components/schemas/topologyToolsRead/properties/Icon" }, "ToolPath":{ "$ref":"#/components/schemas/topologyToolsRead/properties/ToolPath" }, "ToolPathTypeID":{ "$ref":"#/components/schemas/topologyToolsRead/properties/ToolPathTypeID" }, "ToolTarget":{ "$ref":"#/components/schemas/topologyToolsRead/properties/ToolTarget" }, "Width":{ "$ref":"#/components/schemas/topologyToolsRead/properties/Width" }, "Height":{ "$ref":"#/components/schemas/topologyToolsRead/properties/Height" }, "ToolTypeID":{ "$ref":"#/components/schemas/topologyToolsRead/properties/ToolTypeID" } }, "type":"object" }, "topologyToolsReadForSelect":{ "properties":{ "ToolID":{ "$ref":"#/components/schemas/topologyToolsRead/properties/ToolID" }, "ToolName":{ "$ref":"#/components/schemas/topologyToolsRead/properties/ToolName" } }, "type":"object" }, "topologyToolsExecuteViewTools":{ "type":"object", "properties":{ "depth":{ "description":"Number of hops from the start vertex.", "type":"integer", "example":0 }, "ZoneID":{ "description":"Zone ID", "type":"string", "example":"3" }, "DeviceID":{ "description":"Device ID", "type":"integer", "example":349 }, "VertexClass":{ "description":"Type of the node", "type":"string", "example":"Device" }, "VertexID":{ "description":"Vertex ID", "type":"string", "example":"1c730895-8505-43a9-ac8e-f18c75edcde9" }, "IPAddress":{ "description":"IP Address", "type":"string", "example":"100.77.220.52" }, "TimestampModified":{ "description":"Time stamp Modified", "type":"string", "example":"2023-09-03 06:00:18" }, "Name":{ "description":"Name of the node", "type":"string", "example":"Element1" }, "NodeIcon":{ "description":"Path to the image icon used to represent the node. Each node will only have one of the following= NodeIcon, NodeFontAwesomeIcon, and NodeUANIcon", "type":"string", "example":"fa fa-server-network" }, "NodeFontAwesomeIcon":{ "description":"FontAwesome icon class. Each node will only have one of the following= NodeIcon, NodeFontAwesomeIcon, and NodeUANIcon.", "type":"string", "example":"fa fa-server-network" }, "NodeUANIcon":{ "description":"Universal Assurance Network icon class. Each node will only have one of the following= NodeIcon, NodeFontAwesomeIcon, and NodeUANIcon.", "type":"string" }, "Group":{ "description":"To check the node is part of tuck away group.", "type":"boolean", "example":true }, "iconColor":{ "description":"Hex code for the node color.", "type":"string" }, "metricColor":{ "description":"Hex code for the metric badge color.", "type":"string" }, "eventColor":{ "description":"Hex code for the event badge color.", "type":"string" }, "radius":{ "description":"Node radius", "type":"integer", "example":20 }, "open":{ "description":"Indicates if the node is open (expanded) or not.", "type":"boolean", "example":false }, "groupId":{ "description":"ID to link a nested node back to its parent.", "type":"string", "example":"1c730895-8505-43a9-ac8e-f18c75edcde9" }, "_type":{ "description":"Type of the node", "type":"string", "example":"Device" }, "_id":{ "description":"Vertex Id", "type":"string", "example":"1c730895-8505-43a9-ac8e-f18c75edcde9" } } }, "linkLinksRead":{ "type":"object", "properties":{ "LinkID":{ "description":"Link ID specified for individual CRUD operations", "type":"integer", "example":"1004" }, "LinkName":{ "description":"The name for the link.", "type":"string", "example":"Unified Assurance Knowledgebase" }, "LinkPath":{ "description":"The relative or absolute URL.", "type":"string", "example":"/vendor/mediawiki/index.php/Main_Page" }, "LinkTypeID":{ "description":"Unique identifier for the type of link.\n\nAllowed Values:\n- 1 => External (the relative or absolute path separate from Unified Assurance)\n- 2 => Internal (the relative path to Unified Assurance UI packages)\n- 3 => Embedded (Embed the whole URL into the link and open the link as a side panel. This is useful if the URL has the same domain but falls outside the Unified Assurance document root. E.g. \"https:///saml/\")", "type":"integer", "example":"1" }, "LinkTypeName":{ "description":"Name of the link type.", "type":"string", "example":"External" }, "LinkIcon":{ "description":"The image used to display for the link.", "type":"string", "example":"fugue/address-book-open.png" }, "OwnerUserID":{ "description":"The ID of the user that owns the link. This can never be an externally-authenticated transient user. 0 means it is public to all users in the owning group.", "type":"integer", "example":"0" }, "OwnerUserGroupID":{ "description":"Unique identifier for the user group owner of the link.", "type":"integer", "example":"0" }, "Viewers":{ "description":"Selection of user groups that have view-only access to link.", "type":"array", "items":{ "type":"object", "properties":{ "UserGroupID":{ "description":"User Group ID", "type":"integer" }, "UserGroupName":{ "description":"User Group Name", "type":"string" } } }, "example":[ ] } } }, "linkLinks":{ "type":"object", "properties":{ "LinkName":{ "description":"The name of the link.\n
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Unified Assurance Knowledgebase" }, "LinkPath":{ "$ref":"#/components/schemas/linkLinksRead/properties/LinkPath" }, "LinkTypeID":{ "$ref":"#/components/schemas/linkLinksRead/properties/LinkTypeID" }, "LinkIcon":{ "$ref":"#/components/schemas/linkLinksRead/properties/LinkIcon" }, "OwnerUserID":{ "$ref":"#/components/schemas/linkLinksRead/properties/OwnerUserID" }, "OwnerUserGroupID":{ "$ref":"#/components/schemas/linkLinksRead/properties/OwnerUserGroupID" }, "Viewers":{ "$ref":"#/components/schemas/linkLinksRead/properties/Viewers" } } }, "linkLinksReadForSelect":{ "type":"object", "properties":{ "LinkID":{ "$ref":"#/components/schemas/linkLinksRead/properties/LinkID" }, "LinkName":{ "$ref":"#/components/schemas/linkLinksRead/properties/LinkName" } } }, "linkLinkGroupsReadByID":{ "type":"object", "properties":{ "LinkGroupName":{ "description":"The name of the Link Group.", "type":"string", "example":"Root" }, "LinkGroupID":{ "description":"The Link Group ID.", "type":"integer", "example":2 }, "ParentLinkGroupID":{ "description":"LinkGroupID of Parent Group", "type":"integer", "example":1 }, "Links":{ "description":"Displays all of the links that are in the group.", "type":"array", "items":{ "type":"object", "properties":{ "LinkID":{ "$ref":"#/components/schemas/linkLinksRead/properties/LinkID" }, "LinkName":{ "$ref":"#/components/schemas/linkLinksRead/properties/LinkName" } } } } } }, "linkLinkGroupsRead":{ "type":"object", "properties":{ "LinkGroupID":{ "description":"Link Group ID specified for individual CRUD operations", "type":"integer", "example":1 }, "LinkGroupName":{ "description":"The name of the Link Group.", "type":"string", "example":"Root" } } }, "linkLinkGroups":{ "type":"object", "properties":{ "LinkGroupName":{ "description":"The link group name.\n
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Root" }, "ParentLinkGroupID":{ "description":"Parent Group ID for the new Link Group", "type":"integer", "example":1 }, "Links":{ "description":"Displays all of the links that are in the group.", "type":"array", "items":{ "type":"integer" }, "example":[ 1004 ] }, "Remove":{ "description":"Remove Link from other Link Groups. If checked, any links added to the group will be removed from other groups.\n\nAllowed Values:\n- 0 => FALSE\n- 1 => TRUE", "type":"boolean", "example":0 } } }, "linkLinkGroupsUpdate":{ "type":"object", "properties":{ "LinkGroupName":{ "$ref":"#/components/schemas/linkLinkGroups/properties/LinkGroupName" }, "Links":{ "description":"Displays all of the links that are in the group.", "type":"array", "items":{ "type":"integer" }, "example":[ 1004 ] }, "Remove":{ "description":"Remove Link from other Link Groups. If checked, any links added to the group will be removed from other groups.\n\nAllowed Values:\n- 0 => FALSE\n- 1 => TRUE", "type":"boolean", "example":0 } } }, "linkLinkGroupsReadForTree":{ "type":"object", "properties":{ "LinkGroupID":{ "description":"Unique identifier for the Link Group.", "type":"integer", "example":1 }, "LinkGroupName":{ "description":"The name of the Link Group.", "type":"string", "example":"Root" }, "leaf":{ "description":"Leaf or Not", "type":"boolean", "example":false }, "iconCls":{ "description":"CSS class for the icon", "type":"string", "example":"x-tree-icon-parent" }, "expanded":{ "description":"Expanded Tree", "type":"boolean", "example":true }, "data":{ "description":"List of LinkGroups", "type":"array", "items":{ "type":"object" }, "example":[ { "LinkGroupID":"2", "LinkGroupName":"Public", "leaf":true, "iconCls":"x-tree-icon-parent" }, { "LinkGroupID":"3", "LinkGroupName":"Operators", "leaf":true, "iconCls":"x-tree-icon-parent" }, { "LinkGroupID":"4", "LinkGroupName":"Admin", "leaf":true, "iconCls":"x-tree-icon-parent" } ] } } }, "linkNavigationRead":{ "type":"object", "properties":{ "PortalGroupID":{ "description":"Portal Group ID", "type":"integer", "example":"1" }, "id":{ "description":"Node ID", "type":"string", "example":"root" }, "text":{ "description":"Node Text", "type":"string", "example":"Root" }, "expanded":{ "description":"Expanded or not", "type":"boolean", "example":true }, "data":{ "description":"List of LinkGroup", "type":"array", "items":{ "type":"object" }, "example":[ { "id":"4", "LinkGroupID":"4", "text":"Admin", "expanded":false }, { "id":"3", "LinkGroupID":"3", "text":"Operators", "expanded":false }, { "id":"2", "LinkGroupID":"2", "text":"Public", "expanded":false } ] }, "total":{ "description":"Total data elements", "type":"integer", "example":3 } } }, "SLMServicesRead":{ "type":"object", "properties":{ "FullFormRec":{ "description":"Full Form Rec", "type":"boolean", "example":true }, "ServiceID":{ "description":"Service ID specified for individual CRUD operations", "type":"string", "example":"0253c68c-6e9c-4d86-be91-ac86c2756648" }, "ServiceName":{ "description":"Service Name", "type":"string", "example":"Service1" }, "ParentServiceID":{ "description":"ServiceID of Parent", "type":"string", "example":"root" }, "EventCriticalThresholdValue":{ "description":"Threshold Value (Events Only)", "type":"integer", "example":90 }, "InstanceID":{ "description":"Used internally on update to determine if a metric needs to be re-created or looked up for a service", "type":"integer", "example":1 }, "MetricWarningThresholdValue":{ "description":"Warning Threshold Value (Metrics Only) is the value used to check for metric violation", "type":"integer", "example":15 }, "_type":{ "description":"Service type. \n\nAllowed Values: \n- Service\n- ServiceMetric\n- ServiceEvent", "type":"string", "example":"Service" }, "MetricCriticalThresholdOperator":{ "description":"Critical Threshold Operator (Metrics Only)\n\nAllowed Values:\n- '==' => Equals\n- '>' => Greater Than\n- '>=' => Greater Than or Equal\n- '<' => Less Than\n- '<=' => Less Than or Equal\n- '!=' => Not Equals", "type":"string", "example":"" }, "EventCriticalThresholdOperator":{ "description":"Threshold Operator (Events only)\n\nAllowed Values:\n- '==' => Equals\n- '>' => Greater Than\n- '>=' => Greater Than or Equal\n- '<' => Less Than\n- '<=' => Less Than or Equal\n- '!=' => Not Equals", "type":"string", "example":"<=" }, "Weight":{ "description":"SLM Weight", "type":"integer", "example":1 }, "Name":{ "description":"Name of the SLM Service", "type":"string", "example":"test" }, "MetricID":{ "description":"Metric ID", "type":"integer", "example":1361 }, "EventMetaEventID":{ "description":"Meta Event ID to send when threshold triggers (Events Only)", "type":"integer", "example":1 }, "OwnerUserID":{ "description":"The ID of the user that owns the service. This can never be an externally-authenticated transient user. 0 means it is public to all users in the owning group.", "type":"integer", "example":0 }, "_parent_id":{ "description":"ServiceID of Parent", "type":"string", "example":"root" }, "MetricPollTime":{ "description":"PollTime for a metric", "type":"integer", "example":300 }, "OwnerUserGroupID":{ "description":"Group that owns the service", "type":"integer", "example":0 }, "StatusID":{ "description":"The service status ID. Either 0 (disabled) or 1 (enabled).", "type":"integer", "example":1 }, "MetricGaugeViewID":{ "description":"Gauge View Type ID (Metrics Only)\n\nAllowed Values:\n- 1 => Linear\n- 2 => Logarithmic", "type":"integer", "example":1 }, "MetricWarningThresholdOperator":{ "description":"Warning Threshold Operator (Metrics Only)\n\nAllowed Values:\n- '==' => Equals\n- '>' => Greater Than\n- '>=' => Greater Than or Equal\n- '<' => Less Than\n- '<=' => Less Than or Equal\n- '!=' => Not Equals", "type":"string", "example":"" }, "_id":{ "description":"Service ID", "type":"string", "example":"0253c68c-6e9c-4d86-be91-ac86c2756648" }, "MetricCriticalThresholdValue":{ "description":"Critical Threshold Value (Metrics Only)", "type":"integer", "example":75 }, "MetricThresholdID":{ "description":"Critical Threshold ID for Metric", "type":"integer", "example":0 }, "TimestampModified":{ "description":"Timestamp Modified", "type":"integer", "example":"1698395096000" }, "iconClass":{ "description":"CSS class describing the service", "type":"string", "example":"fa fa-tachometer x-tree-icon-glyph" }, "ServiceType":{ "description":"Service Type", "type":"string", "example":"Service" }, "StatusIcon":{ "description":"Status Icon", "type":"string", "example":"OrbGreen.png" }, "Status":{ "description":"Status of the Service (Enabled or Disabled)", "type":"string", "example":"Enabled" } } }, "SLMServicesReadByID":{ "type":"object", "properties":{ "FullFormRec":{ "$ref":"#/components/schemas/SLMServicesRead/properties/FullFormRec" }, "ServiceID":{ "$ref":"#/components/schemas/SLMServicesRead/properties/ServiceID" }, "ServiceName":{ "$ref":"#/components/schemas/SLMServicesRead/properties/ServiceName" }, "ServiceType":{ "$ref":"#/components/schemas/SLMServicesRead/properties/ServiceType" }, "ParentServiceID":{ "$ref":"#/components/schemas/SLMServicesRead/properties/ParentServiceID" }, "OwnerUserID":{ "$ref":"#/components/schemas/SLMServicesRead/properties/OwnerUserID" }, "OwnerUserGroupID":{ "$ref":"#/components/schemas/SLMServicesRead/properties/OwnerUserGroupID" }, "MetricThresholdID":{ "$ref":"#/components/schemas/SLMServicesRead/properties/MetricThresholdID" }, "iconClass":{ "$ref":"#/components/schemas/SLMServicesRead/properties/iconClass" }, "path":{ "description":"Tree path from the root down to this service.", "type":"string", "example":"/Root/test" }, "treedata":{ "description":"Tree path from the root down to this service broken out into array elements.", "type":"array", "items":{ "type":"string" }, "example":"0253c68c-6e9c-4d86-be91-ac86c2756648" }, "_type":{ "$ref":"#/components/schemas/SLMServicesRead/properties/_type" }, "EventCriticalThresholdOperator":{ "$ref":"#/components/schemas/SLMServicesRead/properties/EventCriticalThresholdOperator" }, "EventCriticalThresholdValue":{ "$ref":"#/components/schemas/SLMServicesRead/properties/EventCriticalThresholdValue" }, "InstanceID":{ "$ref":"#/components/schemas/SLMServicesRead/properties/InstanceID" }, "MetricCriticalThresholdOperator":{ "$ref":"#/components/schemas/SLMServicesRead/properties/MetricCriticalThresholdOperator" }, "MetricCriticalThresholdValue":{ "$ref":"#/components/schemas/SLMServicesRead/properties/MetricCriticalThresholdValue" }, "MetricWarningThresholdOperator":{ "$ref":"#/components/schemas/SLMServicesRead/properties/MetricWarningThresholdOperator" }, "MetricWarningThresholdValue":{ "$ref":"#/components/schemas/SLMServicesRead/properties/MetricWarningThresholdValue" }, "Weight":{ "$ref":"#/components/schemas/SLMServicesRead/properties/Weight" }, "Name":{ "$ref":"#/components/schemas/SLMServicesRead/properties/Name" }, "MetricID":{ "$ref":"#/components/schemas/SLMServicesRead/properties/MetricID" }, "EventMetaEventID":{ "$ref":"#/components/schemas/SLMServicesRead/properties/EventMetaEventID" }, "_parent_id":{ "$ref":"#/components/schemas/SLMServicesRead/properties/_parent_id" }, "MetricPollTime":{ "$ref":"#/components/schemas/SLMServicesRead/properties/MetricPollTime" }, "MetricGaugeViewID":{ "$ref":"#/components/schemas/SLMServicesRead/properties/MetricGaugeViewID" }, "_id":{ "$ref":"#/components/schemas/SLMServicesRead/properties/_id" }, "TimestampModified":{ "$ref":"#/components/schemas/SLMServicesRead/properties/TimestampModified" }, "StatusID":{ "$ref":"#/components/schemas/SLMServicesRead/properties/StatusID" }, "Status":{ "$ref":"#/components/schemas/SLMServicesRead/properties/Status" }, "StatusIcon":{ "$ref":"#/components/schemas/SLMServicesRead/properties/StatusIcon" }, "DeviceID":{ "description":"Device ID", "type":"integer", "example":"1" }, "Measurement":{ "description":"Measurement", "type":"string", "example":"metrictype_Service_Availability" }, "HasEventProps":{ "description":"Has event props", "type":"integer", "example":1 }, "HasMetricProps":{ "description":"Has metric props", "type":"integer", "example":1 } } }, "SLMServices":{ "type":"object", "properties":{ "ServiceName":{ "description":"The service name.\n
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.", "type":"string", "example":"Service1" }, "ParentServiceID":{ "$ref":"#/components/schemas/SLMServicesRead/properties/ParentServiceID" }, "CloneServiceID":{ "description":"ServiceID of top level node to be (deep) cloned", "type":"integer" }, "StatusID":{ "$ref":"#/components/schemas/SLMServicesRead/properties/StatusID" }, "OwnerUserID":{ "$ref":"#/components/schemas/SLMServicesRead/properties/OwnerUserID" }, "OwnerUserGroupID":{ "$ref":"#/components/schemas/SLMServicesRead/properties/OwnerUserGroupID" }, "Viewers":{ "description":"List of user groups that can view", "type":"array", "items":{ "type":"object" } }, "EventMetaEventID":{ "$ref":"#/components/schemas/SLMServicesRead/properties/EventMetaEventID" }, "EventCriticalThresholdOperator":{ "$ref":"#/components/schemas/SLMServicesRead/properties/EventCriticalThresholdOperator" }, "EventCriticalThresholdValue":{ "$ref":"#/components/schemas/SLMServicesRead/properties/EventCriticalThresholdValue" }, "MetricsToggle":{ "description":"Metrics Toggle indicating if a service has Metric properties defined", "type":"boolean" }, "MetricPollTime":{ "$ref":"#/components/schemas/SLMServicesRead/properties/MetricPollTime" }, "CriticalThresholdID":{ "description":"Threshold settings used to check if the service is in violation", "type":"integer" }, "MetricCriticalThresholdOperator":{ "$ref":"#/components/schemas/SLMServicesRead/properties/MetricCriticalThresholdOperator" }, "MetricCriticalThresholdValue":{ "$ref":"#/components/schemas/SLMServicesRead/properties/MetricCriticalThresholdValue" }, "WarningThresholdID":{ "description":"Threshold settings used to check if the service is in violation", "type":"integer" }, "MetricWarningThresholdValue":{ "$ref":"#/components/schemas/SLMServicesRead/properties/MetricWarningThresholdValue" }, "MetricWarningThresholdOperator":{ "$ref":"#/components/schemas/SLMServicesRead/properties/MetricWarningThresholdOperator" }, "MetricGaugeViewID":{ "$ref":"#/components/schemas/SLMServicesRead/properties/MetricGaugeViewID" }, "Weight":{ "$ref":"#/components/schemas/SLMServicesRead/properties/Weight" } } }, "SLMServicesReadForTree":{ "type":"object", "properties":{ "ServiceID":{ "description":"Service ID", "type":"string", "example":"0253c68c-6e9c-4d86-be91-ac86c2756648" }, "ServiceName":{ "description":"Service name", "type":"string", "example":"test" }, "leaf":{ "description":"If leaf node or not", "type":"boolean", "example":false }, "iconClass":{ "description":"Icon class used", "type":"string", "example":"fa fa-tachometer x-tree-icon-glyph" }, "path":{ "description":"Tree path for the node", "type":"string", "example":"/Root/test" }, "treedata":{ "description":"Tree data", "type":"array", "items":{ "type":"string", "example":"0253c68c-6e9c-4d86-be91-ac86c2756648" } } } }, "SLMServiceFiltersRead":{ "type":"object", "properties":{ "ParentServiceID":{ "description":"ServiceID of Parent", "type":"string", "example":"2de8190b-4bd8-4a2a-91ec-03e9fdae83e0" }, "_type":{ "description":"Service Type", "type":"string", "example":"ServiceFilter" }, "WhereClause":{ "description":"The clause used to find events to check against threshold.", "type":"string", "example":"" }, "Weight":{ "description":"SLM Weight (weight assigned to the filter)", "type":"integer", "example":1 }, "Name":{ "description":"Name of the SLM Filter", "type":"string", "example":"Some Filter" }, "CompareField":{ "description":"Compare Field", "type":"string", "example":"Count" }, "CompareOperator":{ "description":"Compare Operator\n\nAllowed Values:\n- '==' => Equals\n- '>' => Greater Than\n- '>=' => Greater Than or Equal\n- '<' => Less Than\n- '<=' => Less Than or Equal\n- '!=' => Not Equals", "type":"string", "example":"<=" }, "CompareMetric":{ "description":"Compare Metric\n\nAllowed Values:\n- COUNT\n- SUM\n- MIN\n- MAX\n- AVG", "type":"string", "example":"COUNT" }, "CompareValue":{ "description":"Value against which comparison is done", "type":"number", "example":75 }, "OwnerUserID":{ "description":"The ID of the user who owns the filter. This can never be an externally-authenticated transient user. 0 means it is public to all users in the owning group.", "type":"integer", "example":"0" }, "OwnerUserGroupID":{ "description":"ID of group that owns the filter", "type":"integer", "example":"0" }, "_parent_id":{ "description":"Parent ServiceID", "type":"string", "example":"2de8190b-4bd8-4a2a-91ec-03e9fdae83e0" }, "VertexTypes":{ "description":"Vertex Types", "type":"integer", "example":101 }, "StatusID":{ "description":"The SLM filter status ID. Either 0 (disabled) or 1 (enabled).", "type":"integer", "example":1 }, "StatusIcon":{ "description":"Status Icon", "type":"string", "example":"OrbGreen.png" }, "Status":{ "description":"Status of filter i.e. Enabled or Disabled", "type":"string", "example":"Enabled" }, "_id":{ "description":"Service ID", "type":"string", "example":"2dc9dcc2-635b-4b63-9a0e-35dcb05458c0" }, "TimestampModified":{ "description":"Timestamp when the filter is modified", "type":"integer", "example":"1698332107000" }, "ServiceID":{ "description":"Service ID specified for individual CRUD operations", "type":"string", "example":"2dc9dcc2-635b-4b63-9a0e-35dcb05458c0" }, "ServiceName":{ "description":"Service name", "type":"string", "example":"Some Filter" }, "ServiceType":{ "description":"Service type", "type":"string", "example":"Filter" }, "qtip":{ "description":"Filter name", "type":"string", "example":"Some Filter" }, "icon":{ "description":"SLM Filter Icon", "type":"string", "example":"/resources/assure1/images/icons/fugue/funnel--exclamation.png" }, "leaf":{ "description":"If leaf node or not", "type":"boolean", "example":true }, "Viewers":{ "description":"User groups that have access to view the filter", "type":"object", "example":[ ] } } }, "SLMServiceFilters":{ "type":"object", "properties":{ "ServiceName":{ "$ref":"#/components/schemas/SLMServiceFiltersRead/properties/ServiceName" }, "ParentServiceID":{ "$ref":"#/components/schemas/SLMServiceFiltersRead/properties/ParentServiceID" }, "OwnerUserID":{ "$ref":"#/components/schemas/SLMServiceFiltersRead/properties/OwnerUserID" }, "OwnerUserGroupID":{ "$ref":"#/components/schemas/SLMServiceFiltersRead/properties/OwnerUserGroupID" }, "Viewers":{ "$ref":"#/components/schemas/SLMServiceFiltersRead/properties/Viewers" }, "CompareField":{ "$ref":"#/components/schemas/SLMServiceFiltersRead/properties/CompareField" }, "CompareMetric":{ "$ref":"#/components/schemas/SLMServiceFiltersRead/properties/CompareMetric" }, "CompareOperator":{ "$ref":"#/components/schemas/SLMServiceFiltersRead/properties/CompareOperator" }, "CompareValue":{ "$ref":"#/components/schemas/SLMServiceFiltersRead/properties/CompareValue" }, "WhereClause":{ "$ref":"#/components/schemas/SLMServiceFiltersRead/properties/WhereClause" }, "Weight":{ "$ref":"#/components/schemas/SLMServiceFiltersRead/properties/Weight" }, "StatusID":{ "$ref":"#/components/schemas/SLMServiceFiltersRead/properties/StatusID" } } }, "SLMServiceMetricsRead":{ "type":"object", "properties":{ "ParentServiceID":{ "description":"ServiceID of Parent", "type":"string", "example":"0253c68c-6e9c-4d86-be91-ac86c2756648" }, "TimeFilterStatusID":{ "description":"The time filter status ID. Either 0 (disabled) or 1 (enabled).", "type":"integer", "example":0 }, "ThresholdID":{ "description":"Threshold ID (threshold that will be set against the metric)", "type":"integer", "example":0 }, "_type":{ "description":"Service Type", "type":"string", "example":"ServiceMetric" }, "TimeFilterAllHour":{ "description":"Time Filter every hour", "type":"integer", "example":0 }, "Weight":{ "description":"SLM Weight (how much weight to give the metric)", "type":"integer", "example":1 }, "Name":{ "description":"Name of the SLM Metric", "type":"string", "example":"metric met" }, "CompareType":{ "description":"Compare Threshold Type\n\nAllowed Values:\n- 'availability' => Availability\n- 'value' => Value\n- 'utilization' => Utilization (%)", "type":"string", "example":"utilization" }, "CompareOperator":{ "description":"Comparison Operator\n\nAllowed Values:\n- '==' => Equals\n- '>' => Greater Than\n- '>=' => Greater Than or Equal\n- '<' => Less Than\n- '<=' => Less Than or Equal\n- '!=' => Not Equals", "type":"string", "example":"<=" }, "CompareValue":{ "description":"Compare Threshold Value", "type":"number", "example":90 }, "MetricID":{ "description":"Metric ID", "type":"integer", "example":551 }, "OwnerUserID":{ "description":"The ID of the user who owns the metric. This can never be an externally-authenticated transient user. 0 means it is public to all users in the owning group.", "type":"integer", "example":"0" }, "_parent_id":{ "description":"Parent ServiceID", "type":"string", "example":"0253c68c-6e9c-4d86-be91-ac86c2756648" }, "VertexTypes":{ "description":"Vertex Type", "type":"integer", "example":102 }, "OwnerUserGroupID":{ "description":"Group that owns the metric", "type":"integer", "example":"0" }, "StatusID":{ "description":"The SLM metric status ID. Either 0 (disabled) or 1 (enabled).", "type":"integer", "example":1 }, "StatusIcon":{ "description":"Status Icon", "type":"string", "example":"OrbGreen.png" }, "Status":{ "description":"Status of the service metric i.e. Enabled or Disabled", "type":"string", "example":"Enabled" }, "_id":{ "description":"Service Metric ID", "type":"string", "example":"41d09c41-61f0-4827-801e-a54785ed4498" }, "WindowStatusID":{ "description":"The window status ID. Either 0 (disabled) or 1 (enabled).", "type":"integer", "example":0 }, "TimestampModified":{ "description":"Timestamp when service is modified", "type":"integer", "example":"1698397724000" }, "ServiceID":{ "description":"Service Metric ID specified for individual CRUD operations", "type":"string", "example":"41d09c41-61f0-4827-801e-a54785ed4498" }, "ServiceName":{ "description":"Service Name", "type":"string", "example":"metric met" }, "ServiceType":{ "description":"Type of Service", "type":"string", "example":"Metric" }, "qtip":{ "description":"Service Name", "type":"string", "example":"metric met" }, "icon":{ "description":"Service Icon", "type":"string", "example":"/resources/assure1/images/icons/silk/chart_curve.png" }, "leaf":{ "description":"Leaf node or not", "type":"boolean", "example":true }, "DeviceID":{ "description":"Device ID where the metric is associated", "type":"integer", "example":"60" }, "DeviceName":{ "description":"Device name where the metric is associated", "type":"string", "example":"something.example-device.com" }, "DeviceZoneID":{ "description":"Zone ID of the device", "type":"integer", "example":"1" }, "DeviceZoneName":{ "description":"Zone name of the device", "type":"string", "example":"Default First Zone" }, "MetricTypeID":{ "description":"Metric Type ID used to lookup metrics associated to Device", "type":"integer", "example":"30" }, "MetricTypeName":{ "description":"Metric Type Name", "type":"string", "example":"CPU Utilization" }, "InstanceName":{ "description":"Name of all metric instances available for the selected metric type", "type":"string", "example":"Device" }, "TimeToggle":{ "description":"Time Toggle", "type":"integer", "example":0 }, "Viewers":{ "description":"User groups that have access to view the metric", "type":"object", "example":[ ] } } }, "SLMServiceMetrics":{ "type":"object", "properties":{ "ServiceName":{ "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/ServiceName" }, "ParentServiceID":{ "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/ParentServiceID" }, "OwnerUserID":{ "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/OwnerUserID" }, "OwnerUserGroupID":{ "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/OwnerUserGroupID" }, "Viewers":{ "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/Viewers" }, "CompareType":{ "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/CompareType" }, "ThresholdID":{ "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/ThresholdID" }, "CompareOperator":{ "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/CompareOperator" }, "CompareValue":{ "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/CompareValue" }, "MetricID":{ "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/MetricID" }, "TimeToggle":{ "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/TimeToggle" }, "TimeFilterStatusID":{ "description":"The time filter status ID. This parameter is required if the TimeToggle parameter is specified.
    Allowed values are:\n
    • -1: Inverted, indicates that the time filter is exception based.
      • \n
    • 0: Disabled
      • \n
    • 1: Enabled
    ", "type":"integer", "example":0 }, "TimeFilterAllHour":{ "description":"Time Filter every hour (required if $TimeToggle not empty)", "type":"integer", "example":0 }, "TimeFilterStartDayID":{ "description":"Time Filter Start Day ID (required if $TimeToggle not empty)\n\nAllowed Values:\n- -1 => Everyday\n- 0 => Sunday\n- 1 => Monday\n- 2 => Tuesday\n- 3 => Wednesday\n- 4 => Thursday\n- 5 => Friday\n- 6 => Saturday", "type":"integer" }, "TimeFilterStopDayID":{ "description":"Time Filter Stop Day ID (required if $TimeToggle not empty)\n\nAllowed Values:\n- 0 => Sunday\n- 1 => Monday\n- 2 => Tuesday\n- 3 => Wednesday\n- 4 => Thursday\n- 5 => Friday\n- 6 => Saturday", "type":"integer" }, "TimeFilterStartHourID":{ "description":"Time Filter Start Hour (required if $TimeToggle not empty)", "type":"integer" }, "TimeFilterStopHourID":{ "description":"Time Filter Start Hour (required if $TimeToggle not empty)", "type":"integer" }, "WindowStatusID":{ "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/WindowStatusID" }, "Weight":{ "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/Weight" }, "StatusID":{ "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/StatusID" } } }, "SLMServiceMetricsReadMetricInstances":{ "type":"object", "properties":{ "MetricID":{ "description":"Metric ID", "type":"integer", "example":"583" }, "InstanceName":{ "description":"Instance Name", "type":"string", "example":"Device" }, "DisplayInstanceName":{ "description":"Display Instance Name", "type":"string", "example":"Device" } } }, "SLMServiceMetricsReadMetricTypes":{ "type":"object", "properties":{ "MetricTypeID":{ "description":"Metric Type ID (readMetricInstances only) used to lookup metrics associated to Device", "type":"integer", "example":"63" }, "MetricTypeName":{ "description":"Metric Type Name associated with MetricTypeID", "type":"string", "example":"Ping Jitter Utilization" }, "Measurement":{ "description":"Measurement", "type":"string", "example":"metrictype_Ping_Jitter_Utilization" } } }, "SLMServiceModelFilters":{ "type":"object", "properties":{ "Name":{ "$ref":"#/components/schemas/SLMServiceFiltersRead/properties/ServiceName" }, "_parent_id":{ "$ref":"#/components/schemas/SLMServiceFiltersRead/properties/ParentServiceID" }, "OwnerUserID":{ "$ref":"#/components/schemas/SLMServiceFiltersRead/properties/OwnerUserID" }, "OwnerUserGroupID":{ "$ref":"#/components/schemas/SLMServiceFiltersRead/properties/OwnerUserGroupID" }, "Viewers":{ "$ref":"#/components/schemas/SLMServiceFiltersRead/properties/Viewers" }, "CompareField":{ "$ref":"#/components/schemas/SLMServiceFiltersRead/properties/CompareField" }, "CompareMetric":{ "$ref":"#/components/schemas/SLMServiceFiltersRead/properties/CompareMetric" }, "CompareOperator":{ "$ref":"#/components/schemas/SLMServiceFiltersRead/properties/CompareOperator" }, "CompareValue":{ "$ref":"#/components/schemas/SLMServiceFiltersRead/properties/CompareValue" }, "WhereClause":{ "$ref":"#/components/schemas/SLMServiceFiltersRead/properties/WhereClause" }, "Weight":{ "$ref":"#/components/schemas/SLMServiceFiltersRead/properties/Weight" }, "StatusID":{ "$ref":"#/components/schemas/SLMServiceFiltersRead/properties/StatusID" } } }, "SLMServiceModelMetrics":{ "type":"object", "properties":{ "Name":{ "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/ServiceName" }, "_parent_id":{ "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/ParentServiceID" }, "OwnerUserID":{ "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/OwnerUserID" }, "OwnerUserGroupID":{ "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/OwnerUserGroupID" }, "Viewers":{ "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/Viewers" }, "CompareType":{ "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/CompareType" }, "ThresholdID":{ "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/ThresholdID" }, "CompareOperator":{ "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/CompareOperator" }, "CompareValue":{ "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/CompareValue" }, "MetricID":{ "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/MetricID" }, "TimeToggle":{ "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/TimeToggle" }, "TimeFilterStatusID":{ "description":"The time filter status ID. This parameter is required if the TimeToggle parameter is specified.
    Allowed values are:\n
    • -1: Inverted, indicates that the time filter is exception based.
      • \n
    • 0: Disabled
      • \n
    • 1: Enabled
    ", "type":"integer", "example":0 }, "TimeFilterAllHour":{ "description":"Time Filter every hour (required if $TimeToggle not empty)", "type":"integer", "example":0 }, "TimeFilterStartDayID":{ "description":"Time Filter Start Day ID (required if $TimeToggle not empty)\n\nAllowed Values:\n- -1 => Everyday\n- 0 => Sunday\n- 1 => Monday\n- 2 => Tuesday\n- 3 => Wednesday\n- 4 => Thursday\n- 5 => Friday\n- 6 => Saturday", "type":"integer" }, "TimeFilterStopDayID":{ "description":"Time Filter Stop Day ID (required if $TimeToggle not empty)\n\nAllowed Values:\n- 0 => Sunday\n- 1 => Monday\n- 2 => Tuesday\n- 3 => Wednesday\n- 4 => Thursday\n- 5 => Friday\n- 6 => Saturday", "type":"integer" }, "TimeFilterStartHourID":{ "description":"Time Filter Start Hour (required if $TimeToggle not empty)", "type":"integer" }, "TimeFilterStopHourID":{ "description":"Time Filter Start Hour (required if $TimeToggle not empty)", "type":"integer" }, "WindowStatusID":{ "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/WindowStatusID" }, "Weight":{ "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/Weight" }, "StatusID":{ "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/StatusID" } } }, "SLMServiceViewsReadForTree":{ "type":"object", "properties":{ "DeviceID":{ "description":"Device ID", "type":"integer", "example":"1" }, "MetricID":{ "description":"The identifier for a specific metric.", "type":"integer", "example":1 }, "EventCount":{ "description":"The count of events.", "type":"integer", "example":0 }, "EventFilter":{ "description":"The filter condition for events.", "type":"string", "example":"EventKey='Service_test' AND EventType != 1" }, "EventSumCount":{ "description":"The sum count of events.", "type":"integer", "example":0 }, "MaxSeverity":{ "description":"The maximum severity level.", "type":"integer", "example":0 }, "ServiceID":{ "description":"Service ID", "type":"string", "example":"2de8190b-4bd8-4a2a-91ec-03e9fdae83e0" }, "ServiceName":{ "description":"The name of the service.", "type":"string", "example":"test" }, "ServiceType":{ "description":"The type of the service.", "type":"string", "example":"Service" }, "StateIcons":{ "description":"Icons for different states.", "type":"object", "example":{ "event":"gray" } }, "StateTooltips":{ "description":"Tooltips for different states.", "type":"object", "example":{ "event":"Unknown" } }, "StateValues":{ "description":"Values for different states.", "type":"object", "example":{ "event":0 } }, "ServiceTEL":{ "description":"The service's TEL (Telecommunications Equipment List) information.", "type":"string", "example":"" }, "ServiceStateColor":{ "description":"The color associated with the service's state.", "type":"string", "example":"gray" }, "qtip":{ "description":"Tooltip information.", "type":"string", "example":"Service:
    " }, "iconCls":{ "description":"CSS class for icons.", "type":"string", "example":"fa fa-tachometer x-tree-icon-glyph gray" }, "leaf":{ "description":"Indicates if it's a leaf node.", "type":"boolean", "example":false } } }, "SLMNavigationReadForTree":{ "type":"object", "properties":{ "leaf":{ "description":"Indicates if it's a leaf node.", "type":"boolean", "example":false }, "iconCls":{ "description":"Icon CSS class for the initial status.", "type":"string", "example":"barspinner" }, "view":{ "description":"URL for viewing the service node details.", "type":"string", "example":"#dashboard/Services%20Dashboard?ServiceName=%2F%2FRoot%2F%2FTest%20Service&ResolveParam=ServiceWhereClause" }, "ServiceID":{ "description":"The unique identifier for the service.", "type":"string", "example":"2de8190b-4bd8-4a2a-91ec-03e9fdae83e0" }, "ServiceName":{ "description":"The name of the service.", "type":"string", "example":"Test Service" }, "text":{ "description":"The text associated with the node.", "type":"string", "example":"Test Service" }, "ServiceType":{ "description":"The type of Service node. \n\nPossible values: \n- ServiceFilter\n- ServiceMetric\n- Service", "type":"string", "example":"Service" } } }, "SuccessfulGetOperation":{ "description":"The response body for a successful get operation.", "properties":{ "success":{ "description":"Whether the operation was a success (true) or a failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message.", "type":"string", "example":"Loaded 1 entries" } }, "type":"object" }, "SuccessfulAddOperation":{ "description":"The response body for a successful add operation.", "properties":{ "success":{ "description":"Whether the operation was a success (true) or a failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message.", "type":"string", "example":"Added record" } }, "type":"object" }, "SuccessfulUpdateOperation":{ "description":"The response body for a successful update operation.", "properties":{ "success":{ "description":"Whether the operation was a success (true) or a failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message.", "type":"string", "example":"Updated record" } }, "type":"object" }, "SuccessfulDeleteOperation":{ "description":"The response body for a successful delete operation.", "properties":{ "success":{ "description":"Whether the operation was a success (true) or a failure (false).", "type":"boolean", "example":"true" }, "message":{ "description":"The response message.", "type":"string", "example":"Deleted record" } }, "type":"object" } }, "responses":{ "SuccessfulGetResponse":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SuccessfulGetOperation" } } } }, "SuccessfulAddResponse":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SuccessfulAddOperation" } } } }, "SuccessfulUpdateResponse":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SuccessfulUpdateOperation" } } } }, "SuccessfulDeleteResponse":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SuccessfulDeleteOperation" } } } }, "FailedOperation":{ "description":"Failed operation", "content":{ "application/json":{ "schema":{ "properties":{ "success":{ "description":"Whether the operation was a success (true) or a failure (false).", "type":"boolean", "example":"false" }, "message":{ "description":"The response message.", "type":"string", "example":"Exception thrown" }, "errors":{ "description":"The list of errors reported. Validation errors will be keyed by record field.", "type":"array", "items":{ "description":"An error.", "type":"object" } } }, "type":"object" } } } } }, "parameters":{ "filter":{ "name":"filter", "in":"query", "description":"The fields to filter the results by. You cannot filter by fields that contain a state.
    \nThis parameter's value uses the following JSON format:\n
    \n {\n \"property\": \"property\",\n \"value\": \"propertyValue\", \n \"operator\": \"operator\",\n \"conjunction\": \"conjunction\"\n }\n
    If you use multiple JSON objects to combine filters, for example, to filter by several different device names, you cannot combine OR and AND conjunctions. The conjunction used for the last object applies to the entire list.", "required":false, "schema":{ "required":[ "property", "value" ], "properties":{ "property":{ "description":"The name of the field to filter on.", "type":"string", "example":"name" }, "value":{ "description":"The value of the field to filter on.", "type":"string", "example":"test" }, "operator":{ "description":"The filter operation to use.", "type":"string", "default":"LIKE", "enum":[ "eq", "ne", "gte", "gt", "lte", "lt", "LIKE", "NOT LIKE", "re", "not re", "NOT IN" ], "example":"eq" }, "conjunction":{ "description":"The conjunction between filters.", "type":"string", "default":"OR", "enum":[ "AND", "OR" ], "example":"AND" } }, "type":"object" } }, "limit":{ "name":"limit", "in":"query", "description":"The number of records to limit results by. If you do not also set the start parameter, records start at 0.", "required":false, "schema":{ "type":"integer", "format":"int32", "example":"100" } }, "query":{ "name":"query", "in":"query", "description":"A string to search for. This is a primitive filter, generally applied as a filter on a name parameter, but each endpoint implements it differently.", "required":false, "schema":{ "type":"string", "example":"text" } }, "sort":{ "name":"sort", "in":"query", "description":"The field and direction to sort results by. You cannot sort by fields that contain a state.
    \nThis parameters value uses the following JSON format:\n {\n \"property\": \"property\",\n \"direction\": \"direction\"\n }", "required":false, "schema":{ "required":[ "property", "direction" ], "properties":{ "property":{ "description":"The field to sort on.", "type":"string", "example":"name" }, "direction":{ "description":"The direction of the sort.", "type":"string", "enum":[ "ASC", "DESC" ], "example":"ASC" } }, "type":"object", "example":[ { "property":"Name", "direction":"ASC" }, { "property":"Value", "direction":"DESC" } ] } }, "start":{ "name":"start", "in":"query", "description":"The page of results to start from. This parameter is ignored if you do not also set the limit parameter.", "required":false, "schema":{ "type":"integer", "format":"int32", "default":"0", "example":"1" } }, "group":{ "name":"group", "in":"query", "description":"The group parameter. It groups results by field and direction.\n
    \nThis parameters value uses the following JSON format:\n
    {\n
    \"property\": \"property\",\n
    \"direction\": \"direction\"\n
    }", "required":false, "schema":{ "required":[ "property", "direction" ], "properties":{ "property":{ "description":"The field name to group by.", "type":"string", "example":"name" }, "direction":{ "description":"The direction of the group.", "type":"string", "enum":[ "ASC", "DESC" ], "example":"ASC" } }, "type":"object" } }, "page":{ "name":"page", "in":"query", "description":"The indicator of the current page of data.", "required":false, "schema":{ "type":"integer", "example":1 } }, "StartTime":{ "description":"StartTime in epoch time seconds", "type":"integer", "example":"now" }, "StopTime":{ "description":"StopTime in epoch time seconds", "type":"integer", "example":"now" }, "TimeRange":{ "description":"Shorthand string that encompasses the start and end times in RFC3339 format or relative time literal format. It will take precedence over StartTime if both are passed in.", "type":"string", "example":"now-24h..now" } } } }