Articles Tagged 'rest'

Articles
List of Possible Filterable Field Names in Spira when Using API

When you use our SOAP or REST web service APIs you will often times want to retrieve a filtered list of data. This is done by using the RemoteFilter that lets you query the list of requirements, test cases, tasks, incidents, etc. and pass in the field to be filtered. This article includes the list of standard fields that you can use in the RemoteFilter.

Using the Spira REST API to Update Artifacts

One of the most common needs when using the Spira REST API is the ability to update an item in the system (e.g. test case, requirement, task, defect, etc.). This article explains how you can use the REST API to do this.

Uploading Screenshots to Spira using the v5.0 REST API

We have had some customers looking to upload files to Spira using our REST API. This article provides some sample code.

How to Install a SpiraTeam Database from our Cloud Servers Locally

This article explains the process for taking a SpiraTeam (or SpiraTest, SpiraPlan) backup image from Inflectra's cloud servers and installing it on a local "on-premise" instance of SpiraTeam. This can happen when you have been using SpiraTeam in the cloud, but now want to host it locally.

Changing REST Headers When Web Service Testing

When performing web service testing using Rapise you may need to change the HTTP headers being sent with the request. This article provides suggestions on the different ways of doing this.

Dynamically constructing the .rest file URLs to test REST APIs

Sometimes when using Rapise to test REST web services, you want to be able to dynamically change the base URL of the web service yet still use the same URL template and method information. This article describes a process for achieving this.

Accessing the Spira v4.2 REST API to get test cases in a release

This article describes the process and provides an example for accessing the Spira v4.2 REST API to get a filtered list of test cases in a release.

How to Use Sub-Tests and Common Objects with REST Web Service Tests

It is often useful to have a common set of code libraries and objects that can be reused amongst multiple tests. With Rapise this can be done by creating a common test and then including it into the other actual tests. However due to the way REST web service tests are stored, there are some slight changes needed to handle REST services. This articles describes the process.

Note: if you have Rapise 8.0+ there is a simpler way, just create a module for REST service calls.

Accessing the Spira 6.0 REST API using C# .NET

We have had several requests for sample code illustrating how to access the Spira 6.0 REST API in C# code. You can of course use the SOAP API instead where Visual Studio auto-generates the C# code for you, but since we have a complete REST Unit Test framework in C#, we are sharing the sample code

Uploading Screenshots to Spira using the v6.0 REST API

We have had some customers looking to upload files to Spira using our REST API. This article provides some sample code.

Using the Spira REST API to Remove Test Cases from a Test Set

We had a customer that was looking for a more automated way to remove test cases from a test set. The good news is that our REST API makes this easy.

Creating a new Test Run in Spira using the v6.0 REST API

Although we have comprehensive documentation published on our website regarding the Spira REST API, sometimes users need some additional examples. In this article we publish an example of how to record a new test run using our REST API.

How to integrate Rapise and Elasticsearch

Rapise is a test automation platform for desktop, web and mobile applications. It is designed for building automated and manual end-to-end UI tests and fits any TestOps infrastructure.

Elasticsearch is a distributed, RESTful search and analytics engine capable of solving a growing number of use cases. As the heart of the Elastic Stack, it centrally stores your data so you can discover the expected and uncover the unexpected.

From this article you will learn how to integrate Rapise and Elasticsearch together.

Useful constants when calling the Spira API
Sometimes when using our SOAP or REST APIs there are constants that are useful for some of the filters. In many cases they are included in the build-in API documentation, but sometimes they are not listed. This article details some of the release/requirement ones that may be useful: