Table Of Contents

Test Monitor HTTP API Reference

Version:
    Last Modified: June 28, 2018

    Use the following table to determine requests to make to monitor tests in NI SystemLink Web Application. Append the HTTP URI to the full computer name to make requests. Refer to the full API documentation for more details about each request.

    Name Description Method HTTP URI Optional Parameters
    Ping Returns HTTP status code 200 OK or, if an error occurs, a JSON error object. GET /nitestmonitor/v1/ping None
    Create Test Result Creates a new test result with the specified information. POST /nitestmonitor/v1/results None
    Delete Test Result Deletes the test result whose test result ID matches the given ID. DELETE /nitestmonitor/v1/results/<ID> None
    Delete Many Test Results Deletes all test results whose test result ID matches one of the given IDs. POST /nitestmonitor/v1/delete-results None
    Update Test Result

    Updates the values of the test result object in the database.

    PUT /nitestmonitor/v1/results/<ID>
    • replace
      • If True, existing elements are replaced with the new values.
      • If False, the existing elements are merged with the new values where possible.
      • Default: False
    • determineStatusFromSteps
      • If True, the status is set to the highest state value from all of the related test steps.
      • Default: False
    Query Test Results Returns list of Test Result objects, wrapped by an Error Wrapper. POST /nitestmonitor/v1/query-results Query parameters:
    • skip - integer >=0 that indicates a particular number of matching test results to skip before including them in the result. If not provided, this defaults to 0.
    • take - integer that indicates the maximum number of matching test results to return. If not provided, this defaults to 1000.
    Delete Test Step Deletes the test step whose sequence ID matches the given ID. DELETE /nitestmonitor/v1/steps/<ID> None
    Delete Many Test Steps Deletes all test steps whose test result ID matches one of the given IDs. POST /nitestmonitor/v1/delete-steps None
    Post Test Step Updates Posts a list of test step objects. Objects that either have no ID or have an unknown ID are created. Objects with an existing ID are updated to match the new given fields. POST /nitestmonitor/v1/steps None
    Query Test Steps

    Returns object containing results, a list of test step objects which match the query.

    POST /nitestmonitor/v1/query-steps
    • skip - integer >=0, indicates a particular number of matching test steps to skip before including them in the result. If not provided, this defaults to 0.
    • take - int, indicates the maximum number of matching test steps to return. If not provided, this defaults to 1000.

    Recently Viewed Topics