Working with CLI and REST APIs in XPRESSO

XPRESSO supports a range of CLI and REST APIs to assist automation engineers with the development of automated test cases which can work across IOS/Non-IOS platforms and essential tooling support for test execution control and scheduling.

Topics in this section include which CLI and REST APIs are supported in XPRESSO and the general usage rules that apply when working with APIs:

WARNING!
XPRESSO has started to roll out version 2 of the REST APIs. All new features going forward will only be supported by version 2. It is advised that all users develope for the newest API version. Version 1 will continue to operate as normal.

• Supported REST APIs: XPRESSO supports the following REST APIs:

  • Request(s) and Bundle Requests REST APIs: Provides access to the following Request(s) and Bundle Requests REST APIs:

    • Requests: Submit | Retrieve | Stop
    • Bundle Requests: Submit

  • Result(s) REST APIs: Provides access to the following Result(s) REST APIs:

    • Results: Retrieve | Download

  • Job(s), Bundle(s), and Profile(s) REST APIs: Provides access to the following Job(s), Bundle(s), and Profile(s) REST APIs.

    • Job(s): Retrieve
    • Bundle(s): Retrieve
    • Profile(s): Retrieve

  • Lab Equipment REST APIs: Provides access to the following Lab Equipment-related REST APIs:

    • Testbed(s): Retrieve
    • Testbed Clean Instructions: Retrieve
    • Topology/Topologies: Retrieve

  • Environment REST APIs: Provides access to the following environment-related REST APIs:

    • Test Harness/Test Harnesses: Retrieve
    • Execution Engine(s): Retrieve

  • Helper REST APIs: Provides access to the following environment-related REST API:

    • Resource meta information: Get

• Supported CLI APIs: XPRESSO supports the following CLI APIs:

  • Management CLI APIs: Provides access to the following Management-related CLI APIs:

    • all Help CLI commands
    • XPRESSO login details
    • XPRESSO configuration settings
    • XPRESSO configuration listing
    • optional arguments

  • Environment CLI APIs: Provides access to the following environment-related CLI APIs:

    • Operating System (OS): Get | List
    • Platforms: Get | List
    • Branch: Get | List | Register

  • Resource CLI APIs: Provides access to the following Resource-related CLI APIs:

    • Testbeds: Get | List
    • Topologies: Get | List

  • Job CLI APIs: Provides access to the following Job-related REST API:

    • Job: Get | List

  • Reservation CLI APIs: Provides access to the following Reservation-related REST API:

    • Reservation: Get | List | Extend | Release

  • Requests, Bundle, Results, and Baseline CLI APIs: Provides access to the following Requests, Bundle, Results, and Baseline-related CLI APIs:

    • Standalone Requests: Get | List | Submit | Stop
    • Bundled Requests: Get | List
    • Results: Compare | Attach
    • Baseline: Compare | List | Propagate | Set | Set-attribute | Unset | Unset-attribute | Update