Data Sources Web Service

You can manage data sources using the
datasources
web service.
You can perform the following tasks to manage data sources using the
datasources
web service:
  • Get item IDs from local IDs.
  • Get local IDs from the item IDs.
  • Manage the data source log file.
  • Modify data source settings, such as the authentication method to use.
  • Register new data sources.
  • Remove data sources.
  • Synchronize data sources.
  • View the current registered data sources.
  • Get the current PC version.
Access the datasources Web Service Documentation
As a local admin user, issue the following call to see the parameters for the
datasources
web service:
http://
PC_host
:8181/pc/center/webservice/datasources
As a local admin user, issue the following call to see a list of supported operations:
http://
PC_host
:8181/pc/center/rest/datasources/documentation
Retrieve the Values for the Data Source Parameters
You can retrieve the current values for the following data source parameters using the GET command:
  • id
    An internally assigned identifier for the data source.
  • enabled
    Indicates whether the data source is enabled.
    Default:
    true
  • name
    The hostname of the data source.
  • authtype
    The type of authentication to use for this data source.
    Values:
    NONE, BASIC
  • type
    Values:
    • REPORTER:
      Network Flow Analysis
    • SUPER_AGENT:
      CA Application Delivery Analysis
    • VOIP_MONITOR:
      CA Unified Communications Monitor
    • EVENT_MANAGER:
      The Event Manager service
    • SPECTRUM_IM:
      DX NetOps Spectrum
    • APM:
      CA Application Performance Management
    • DATA_AGGREGATOR:
      The default
      DX NetOps Performance Management
      data source
    • CATALYST_CONNECTOR:
      The CA Catalyst Connector
    • SERVICE_OPERATIONS_INSIGHT:
      CA Service Operations Insight
    • RESERVED_CUSTOMER_N:
      An enum that has been reserved for the unspecified custom uses.
  • consoleSameAsDataSource
    Indicates whether the data source web console address is the same as the hostname. Use this parameter in cases where network address translation is deployed.
    Default:
    true
  • consoleAddress
    The IP address where
    DX NetOps Performance Management
    contacts the data source console.
Data Sources Web Service Examples
The following examples demonstrate some of the operations for the
datasources
web service:
  • get item ids
    Retrieves the
    NetOps Portal
    item ids given the data source local id. If an id is not found, it is omitted from the returned data.
    URL:
    http://hostname:8181/pc/center/webservice/datasources/{idName}/{idValue}/itemids
    Where:
    • {idName}
      One of the property name values that the get id names method of this web service returns.
      {idName}
      can be any of the following values:
      • dataSourceId
        Example:
        http://
        PC_address
        :8181/pc/center/webservice/datasources/dataSourceId/3/itemids
      • dataSourceGUID
        Example:
        http://
        PC_address
        :8181/pc/center/webservice/datasources/dataSourceGUID/7b0ef6b1e9094d599821b2b07d78d83d/itemids
      • dataSourceConsoleName
        Example:
        http://
        PC_address
        :8181/pc/center/webservice/datasources/dataSourceConsoleName/Data%20Aggregator%40
        PC_DA
        .ca.com/itemids
    • {idValue}
      A value for the property denoted by
      idName
      .
    HTTP method:
    POST
    XSD for the provided XML:
    http://
    hostname
    :8181/pc/center/rest/datasources/xsd
    To translate an array of local ids into item ids, supply XML in the following format:
    <LocalIDs>
    <LocalID ID="4514"/>
    <LocalID ID="4705"/>
    <LocalID ID="4501"/>
    <LocalID ID="4540"/>
    <LocalID ID="4511"/>
    <LocalID ID="4499"/>
    </LocalIDs>
    The function returns an array of
    ItemIDResult
    objects.
    Example:
    <ItemIDResults>
    <ItemIDResult ItemID="406" LocalID="4514"/>
    <ItemIDResult ItemID="407" LocalID="4705"/>
    <ItemIDResult ItemID="408" LocalID="4501"/>
    <ItemIDResult ItemID="409" LocalID="4540"/>
    <ItemIDResult ItemID="410" LocalID="4511"/>
    <ItemIDResult ItemID="411" LocalID="4499"/>
    </ItemIDResults>
  • get local ids
    Retrieves the data source local id given the
    NetOps Portal
    item ids. If an id is not found, it is omitted from the returned data.
    URL:
    http://
    hostname
    :8181/pc/center/webservice/datasources/{idName}/{idValue}/localids
    Where:
    • {idName}
      One of the property name values that the get id names method of this web service returns.
      {
      idName
      } can be any of the following values:
      • dataSourceId
        Example:
        http://
        PC_address
        :8181/pc/center/webservice/datasources/dataSourceId/3/localids
      • dataSourceGUID
        Example:
        http://
        PC_address
        :8181/pc/center/webservice/datasources/dataSourceGUID/7b0ef6b1e9094d599821b2b07d78d83d/localids
      • dataSourceConsoleName
        Example:
        http://
        PC_address
        :8181/pc/center/webservice/datasources/dataSourceConsoleName/Data%20Aggregator%40
        PC_D
        A.ca.com/localids
    • {idValue}
      A value for the property denoted by
      idName
      .
    HTTP method:
    POST
    XSD for the provided XML:
    http://
    hostname
    :8181/pc/center/rest/datasources/xsd
    To translate an array of the specified
    NetOps Portal
    item ids to local ids, supply XML in the following format:
    <ItemIDs>
    <ItemID ID="412"/>
    <ItemID ID="413"/>
    </ItemIDs
    The function returns an array of
    ItemIDResult
    objects.
    Example:
    <ItemIDResults>
    <ItemIDResult ItemID="412" LocalID="4590"/>
    <ItemIDResult ItemID="413" LocalID="4760"/>
    </ItemIDResults>