Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

You can use the Parasoft REST API to remotely  create and update virtual assets, as well as create, update, and execute test assets, directly on the Parasoft server. This enables third-party integrations, custom programmatic interactions, and access via additional user interfaces such as Parasoft CTP

Sections include:

Table of Contents
maxLevel1

Prerequisites

Conditional Content
Product: (SOAVirt, SOAtest)
Product: (SOAVirt, SOAtest)
sv-attr:0A010204015A9054C88481D043445E2F0A010204015CF6008A11EEF43AC91334 0A010204015A9054C886C0AC137B8C01
  • The SOAtest server must be running
Conditional Content
Product: (SOAVirt, Virtualize)
Product: (SOAVirt, Virtualize)
sv-attr:0A010204015A9054C88481D043445E2F0A010204015CF6008A11EEF43AC91334 0A010204015A9054C88802B9600247DF
  • The Virtualize server must be running
  • Server API-enabled license
Conditional Content
Product: (SOAVirt, SOAtest)
Product: (SOAVirt, SOAtest)
sv-attr:0A010204015A9054C88481D043445E2F0A010204015CF6008A11EEF43AC91334 0A010204015A9054C886C0AC137B8C01
Info
titleHow do I start SOAtest Server

From the cli: soatestcli -startServer
From the UI: Click the Start Server button in the SOAtest Server view.

If the Start Server button is grayed out and the red Stop Server button is enabled, this means that the server is running.

Conditional Content
Product: (SOAVirt)
Product: (SOAVirt)
sv-attr:0A010204015A9054C88481D043445E2F0A010204015CF6008A11EEF43AC91334

Make Sure Your License Supports SOAtest Server

Excerpt Include
Licensing
Licensing
nopaneltrue


About the REST API

The REST API enables you to perform core operations, without using the desktop GUI, as well as integrate with other applications or tools that part of your Dev/Test infrastructure. You can create, update, and delete data sources,

Conditional Content
Product: (SOAVirt, SOAtest)
Product: (SOAVirt, SOAtest)
sv-attr:0A010204015A9054C88481D043445E2F0A010204015CF6008A11EEF43AC91334 0A010204015A9054C886C0AC137B8C01

test suites,

 

Conditional Content
Product: (SOAVirt, Virtualize)
Product: (SOAVirt, Virtualize)
sv-attr:0A010204015A9054C88481D043445E2F0A010204015CF6008A11EEF43AC91334 0A010204015A9054C88802B9600247DF

virtual assets,

tools, environments, etc. For details, see the API documentation by opening the following URL in a browser:

http://<host>:9080/soavirt/api 

Your tools may be deployed on different ports.


Conditional Content
Product: (CTP)
Product: (CTP)
sv-attr:0A010204015A9054C88481D043445E2F0A010204015AC49EDCB8ED8A16FC0C95

Authentication and User Access Controls

If the server is connected to a CTP that has security controls configured, you will need to provide the REST API valid admin-level credentials. For details, see About Virtualize Server User Access Control for additional information.

Returning Requests in GZIP Format

The REST API can return requests in GZIP format. This results in smaller payloads being sent over the wire, which decreases the amount of time it takes to read responses from the server.

To have requests returned in GZIP format, the client accessing the REST API just needs to set the following HTTP header:
Accept-Encoding: gzip