Requisitions

A requisition is a group of nodes. OpenNMS APIs allows you to manage the provisioning of requisitions. Requisitions allow you to monitor services in the network. They track status of network devices. You can get information about the pending or deployed requisitions using a GET operation on "active" requisitions.

For more information about referencing a Space device ID as a foreign source and ID pair within OpenNMS APIs, see the "Mapping Space Device IDs to OpenNMS Node IDs" section of the Fault and Performance APIs topic.

APIs for Requisitions

  • /api/space/opennms/requisitions

    Returns all active requisitions.

  • /api/space/opennms/requisitions/count

    Returns the number of active requisitions. This API returns plain text only (instead of XML or JSON format).

  • /api/space/opennms/requisitions/deployed

    Returns the list of all deployed (active) requisitions.

  • /api/space/opennms/requisitions/deployed/count

    Returns the number of deployed requisitions. This API returns plain text only (instead of XML or JSON format).

  • /api/space/opennms/requisitions/{name}

    Returns the active requisition for the given foreign source name.

  • /api/space/opennms/requisitions/{name}/nodes

    Returns the list of nodes being requisitioned for the given foreign source name.

  • /api/space/opennms/requisitions/{name}/nodes/{foreignId}

    Returns the node with the given foreign ID for the given foreign source name.

  • /api/space/opennms/requisitions/{name}/nodes/{foreignId}/interfaces

    Returns the interfaces for the node with the given foreign ID and foreign source name.

  • /api/space/opennms/requisitions/{name}/nodes/{foreignId}/interfaces/{ipAddress}

    Returns the interface with the given IP for the node with the specified foreign ID and foreign source name.

  • /api/space/opennms/requisitions/{name}/nodes/{foreignId}/interfaces/{ipAddress}/services

    Returns the services for the interface with the specified IP address, foreign ID, and foreign source name.

  • /api/space/opennms/requisitions/{name}/nodes/{foreignId}/interfaces/{ipAddress}/services/{service}

    Returns the given service with the specified IP address, foreign ID, and foreign source name.

  • /api/space/opennms/requisitions/{name}/nodes/{foreignId}/categories

    Returns the categories for the node with the given foreign ID and foreign source name.

  • /api/space/opennms/requisitions/{name}/nodes/{foreignId}/categories/{categoryName}

    Returns the category with the given name for the node with the specified foreign ID and foreign source name.

  • /api/space/opennms/requisitions/{name}/nodes/{foreignId}/assets

    Returns the assets for the node with the given foreign ID and foreign source name.