Maintenance outage for upgrade on Sunday, September 22

This site, docs.bmc.com, will be inaccessible for two hours starting at 8 AM CDT, Sunday, September 22, for a platform upgrade.

    Page tree
    Skip to end of metadata
    Go to start of metadata

    BMC ProactiveNet web services provide operations for a web service client to exchange events and data with BMC ProactiveNet. Features of BMC ProactiveNet web services include:

    • Retrieving data from BMC ProactiveNet
    • Managing CIs
    • Generating events for BMC ProactiveNet and its integrations
    • Managing SLO information
    • Managing Central Monitoring Administration on a BMC ProactiveNet Server
    • Retrieving details about BMC ProactiveNet Integration Services

    Accessing BMC ProactiveNet web services

    You can access each BMC ProactiveNet web service through a URL. The generic format of a BMC ProactiveNet web service URL is as follows:

    http|https://<serverHost>:<port>/bppmws/api/<resourceType>/<resourceID>
    /action?<queryParam1>&<queryParam2>&...<queryParamn>

    Example

    https://bppm:443/bppmws/api/slo/create?filtertype=device&
    filterid=device1&filteridtype=name

    Entry

    Description

    http|https

    Type of protocol to send the request. BMC ProactiveNet web services support both HTTP and HTTPS protocols.

    serverHost

    Host name of the BMC ProactiveNet Server

    port

    Port number through which communication is established. The default port number is 80 if you use the HTTP protocol and 443 if you use the HTTPS protocol.

    resourceType

    Type of resource that you want the web service to interact with. BMC ProactiveNet web services support the following resource types:

    • Device
    • MonitorInstance
    • slo
    • CI

    resourceID

    Identifier of a specific resource that you want the web service to interact with. BMC ProactiveNet web services support the following resource identifiers:

    • Name — Name of the resource
    • IPAddress — IP address of the resource
    • URI — Uniform Resource Identifier of the resource
    • RECON_ID — Unique identifier of a configuration item (CI)

    Each web service supports specific resource identifiers, and the supported identifiers vary for each web service.

    action

    Type of action that you want to perform using the web services

    queryParam1, queryParam2, queryParamn

    Additional parameters that you want to provide in the request

    HTTP header error codes

    HTTP error codes are displayed in the HTTP header. These error codes represent a broader category of the actual issue. For more granular details about the error, you must look at the JSON response error codes that are covered in each topic.

    HTTP error codes for web services

    Error code

    Message

    Description

    200

    Success

    Your request was successful.

    203

    Non-Authoritative Information

    Your request has generated a partial response. Contact your administrator for more information.

    400

    Bad Request

    Your request has incorrect parameters or formatting errors.

    401

    Authentication failed. Invalid Username/Password OR Invalid/Expired Token.

    The authentication credentials or the authentication token is incorrect, invalid, or not provided.

    403

    Access denied. You are not authorized to perform this operation.

    Your authentication credentials are valid, but your user role is not authorized to access the resource.

    404

    Not Found

    The resource is not found or does not exist.

    408

    Request Timeout

    The server timed out waiting for the client's request.

    500

    Internal Server Error

    There is some internal issue in BMC ProactiveNet Server.

    501

    Not Implemented

    Either the server does not recognize your request method or it does not have the ability to implement your request.

    503

    Service Unavailable

    The server is temporarily unable to process your request. It might be mostly due to server overload or unavailability.