This topic introduces the Parasoft REST API, which allows you to remotely create and update
| Conditional Content |
|---|
| Product: (SOAVirt, Virtualize) |
|---|
| Product: (SOAVirt, Virtualize) |
|---|
| sv-attr:0A010204015A9054C88481D043445E2F | 0A010204015CF6008A11EEF43AC91334 0A010204015A9054C88802B9600247DF |
|---|
|
virtual assets |
| Conditional Content |
|---|
| Product: (SOAVirt) |
|---|
| Product: (SOAVirt) |
|---|
| sv-attr:0A010204015A9054C88481D043445E2F | 0A010204015CF6008A11EEF43AC91334 |
|---|
|
or |
| Conditional Content |
|---|
| Product: (SOAVirt, SOAtest) |
|---|
| Product: (SOAVirt, SOAtest) |
|---|
| sv-attr:0A010204015A9054C88481D043445E2F | 0A010204015CF6008A11EEF43AC91334 0A010204015A9054C886C0AC137B8C01 |
|---|
|
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:
The REST API covered in this topic focuses on operations associated with creating and updating virtual and test assets. Virtualize and SOAtest also includes a SOAP-based API that focuses on the management, execution, and deployment of virtual and test assets.
for more information about the SOAP-based API.
Prerequisites
| Conditional Content |
|---|
| Product: (SOAVirt, SOAtest) |
|---|
| Product: (SOAVirt, SOAtest) |
|---|
| sv-attr:0A010204015A9054C88481D043445E2F | 0A010204015CF6008A11EEF43AC91334 0A010204015A9054C886C0AC137B8C01 |
|---|
|
- The SOAtest server must be running
|
| Conditional Content |
|---|
| Product: (SOAVirt, Virtualize) |
|---|
| Product: (SOAVirt, Virtualize) |
|---|
| sv-attr:0A010204015A9054C88481D043445E2F | 0A010204015CF6008A11EEF43AC91334 0A010204015A9054C88802B9600247DF |
|---|
|
- The Virtualize server must be running
|
- Server API-enabled license
| Conditional Content |
|---|
| Product: (SOAVirt, SOAtest) |
|---|
| Product: (SOAVirt, SOAtest) |
|---|
| sv-attr:0A010204015A9054C88481D043445E2F | 0A010204015CF6008A11EEF43AC91334 0A010204015A9054C886C0AC137B8C01 |
|---|
|
| Info |
|---|
| title | How 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:0A010204015A9054C88481D043445E2F | 0A010204015CF6008A11EEF43AC91334 |
|---|
| Make Sure Your License Supports SOAtest Server | Excerpt Include |
|---|
| Licensing |
|---|
| Licensing |
|---|
| nopanel | true |
|---|
|
|
|
|
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:0A010204015A9054C88481D043445E2F | 0A010204015CF6008A11EEF43AC91334 0A010204015A9054C886C0AC137B8C01 |
|---|
|
test suites, |
| Conditional Content |
|---|
| Product: (SOAVirt, Virtualize) |
|---|
| Product: (SOAVirt, Virtualize) |
|---|
| sv-attr:0A010204015A9054C88481D043445E2F | 0A010204015CF6008A11EEF43AC91334 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.
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