Resources

This table provides a list of all the resources exposed by this REST web service. More detail about each resource is explored after this table: Export as WADL-JSON

Resource	Methods	Description
Artifact Documents	GET , POST , DELETE	This resource lets you view/add documents associated to an artifact
Association	POST , PUT , GET	This resource lets you create, view and update artifact associations
Automation Engine	GET , POST	This resource lets you create, and view automation engines in the system
Automation Host	GET , POST , PUT , DELETE	This resource lets you create, view, update and delete automation hosts in the system
Custom List	GET , POST , PUT	This resource allows you to retrieve and edit the custom lists defined in a specific project
Custom List Value	POST	This resource allows you to add custom list values to a custom list in a project
Custom Property	GET , POST , PUT , DELETE	This resource allows you to retrieve and edit the custom properties defined in a specific project
Data Mapping Artifacts	GET , POST , DELETE	This resource lets you create and retrieve the data mapping for artifacts
Data Mapping Custom Properties	GET	This resource lets you view the custom property data mappings
Data Mapping Custom Property Values	GET	This resource lets you view the custom property value data mappings
Data Mapping Field Values	GET	This resource lets you view the standard field data mappings
Data Mapping Projects	GET	This resource lets you view the project data mappings
Data Mapping Users	POST , GET	This resource lets you view and add user data mappings
Data Sync	GET , POST	This resource lets you retrieve the data synchronization plugins configured and update the synchronization status
Data Sync Event	POST	This resource lets you record events in Spira from data-synchronization activities
Document	GET , POST , DELETE	This resource allows access to the document attachments in the system
Document Folder	GET , POST , DELETE , PUT	This resources provides access to the active document folders in the project
Document Type	GET	This resources provides access to the active document types in the project
Document Version	POST	This resource lets you add new versions of documents
Incident	GET , POST , PUT , DELETE	This resource allows you to retrieve, create, modify and delete incidents in a specific project in the system.
Incident Comment	GET , POST	This resource allows you to retrieve the comments associated with an incident as well as add new comments to an existing incident.
Incident Priority	GET , POST	This resource allows you to retrieve/create incident priorities defined in a specific project
Incident Severity	GET , POST	This resource allows you to retrieve/create incident severities defined in a specific project
Incident Status	GET , POST	This resource allows you to retrieve/create incident statuses defined in a specific project
Incident Type	POST , GET	This resource allows you to retrieve/create incident types defined in a specific project
Project	GET , POST , DELETE	This resource allows you to retrieve projects in the system
Project Role	GET	This resource lets you view the list of project roles in the system
Project User	GET	This resource allows you to retrieve the users associated with a specific project
Release	GET , POST , PUT , DELETE	This resource allows you to retrieve and manage the releases and iterations defined in a specific project
Release Build	GET , POST	This resource lets you create, and view automated builds in the system
Release Comments	GET , POST	This resource allows you to retrieve the comments associated with a release as well as add new comments to an existing release.
Release Test Cases	POST , DELETE , GET	This resource lets you retrieve, add and remove test cases to/from releases
Requirement	GET , POST , PUT , DELETE	This resource allows you to retrieve, create, modify and delete requirements in a specific project in the system.
Requirement Comment	GET , POST	This resource lets you retrieve and add comments to a requirement in the system.
Requirement Test Coverage	POST , DELETE , GET	This resource lets you view, add and remove test cases from requirements.
System	GET	This resource contains information on the overall product instance, including version and settings information
Task	POST , GET , PUT , DELETE	This resource allows you to retrieve, create, modify and delete tasks in a specific project in the system.
Task Comment	GET	This resource allows you to add and retrieve task comments in the system
Test Case	GET , POST , PUT , DELETE	This resource allows you to retrieve, create, modify and delete test cases in a specific project in the system.
Test Case Comment	GET , POST	This resource lets you add and view comments associated with test cases
Test Case Folder	POST , GET	This resource allows you to create test case folders in the project
Test Case Link	POST	This resource lets you add linked test cases to a test case
Test Case Parameter	POST , GET	This resource allows you to add/remove parameters to test cases
Test Run	PUT , GET , POST	This resource allows you to retrieve, create, modify and delete test runs in a specific project in the system.
Test Set	POST , GET , PUT , DELETE	This resource lets you create, view, edit and delete test sets in the system
Test Set Comment	GET , POST	This resource lets you add and view comments associated with test sets
Test Set Folder	POST	This resource lets you create test set folders in the system
Test Set Test Case	POST , DELETE , GET	This resource lets you create, view, modify the test cases associated with test sets
Test Step	POST , DELETE	This resource lets you create and delete test steps from test cases in the system
Test Step Parameter	GET	This resource lets you retrieve the parameters associated with a specific test step
User	POST , GET , DELETE	This resource lets you create, retrieve and delete users in the system

How To Access The API

Using the Right URL

To access these REST web services, you need to use the specific URL of the application.

For instance, if you access the application in the browser from https://companyname.spiraservice.net, then that will be the base of the URL used for accessing the API. And if you are on version 4, the API URL would be: https://companyname.spiraservice.net/services/v4_0/RestService.svc

If you are viewing this page from your application, the base URL is:

https://api.inflectra.com/spira/services/v4_0/RestService.svc/

Specifying The Data Format

You can specify the format of data that will be returned (XML or JSON) by passing the following HTTP Headers:

Content-Type: application/xml - Sends data in XML format
accept: application/xml - Returns data in XML format
Content-Type: application/json - Sends data in JSON format
accept: application/json - Returns data in JSON format

Note: when sending data to Spira, make sure all tags are sent in alphabetical order

Authentication

There are three different ways to authenticate with the web service. They all need a username and an api-key. The api-key used is the same as the RSS token created by the application. You can find a user's RSS token by either going to the user profile (either by visiting your own profile page, or accessing it via the administration panel). If no RSS token is shown for a user, make sure "Enable RSS Feeds" is set to yes.

Copy the full RSS-token / api-key for the relevant user--including the curly braces { }. In the below examples the username "fredbloggs" is used, with an api-key of "{XXXXXXXXXXXXXXXX}"

Append the username and application API-Key as an extra querystring parameter:
```
?username=fredbloggs&api-key={XXXXXXXXXXXXXXXX}
```
Pass in the username application API-Key using the username and api-key HTTP headers:
```
username: fredbloggs
api-key: {XXXXXXXXXXXXXXXX}
```

Pass in the username and api-key using the standard HTTP basic authentication header:

Authorization: Basic XXXXXXXXXXXXXXXXXXXXXXXXXX
where XXXXXXXXXXXXXXXXXXXXXXXXXX is username:api-key base64 encoded

Accessing Across Domains

Finally if you need to call one of the GET methods from a web page in another domain you need to use the special JSONP (JSON with Padding) syntax. This tells the web service to return the data in the form of a JavaScript <script> tag so that it be can be called across web site domains safely. To request the data in JSONP format, just add the following extra querystring parameter:

?callback=[name of callback function]

Example REST Call

When starting to try out the API we recommend starting with a simple GET request, to make sure the connection is working as expected.

A good first API call to make is to get a list of all projects the user connecting via the API has access to. To make this call we need the following information

The base url for accessing the service (for this current application it is )
The additional query string to get the list of projects (projects)
The username of a user with sufficient access to the system (let's use Fred Bloggs)
The API-key for that user (in this case, let's assume it's {XXXXXXXXXXXXXXXX})
Finally, we need to decide what form we want the information to be sent to us in (we will ask for JSON here)

Putting that all together we can create the URL we need. If we put the authentication into the URL, the full URL will be:

projects?fredbloggs&{XXXXXXXXXXXXXXXX}
with a header of accept: application/json

Resources Details

Artifact Documents

URI	Method	Description
projects/{project_id}/artifact-types/{artifact_type_id}/artifacts/{artifact_id}/documents	GET	Retrieves the list of documents/attachments in a project attached to a specific artifact
projects/{project_id}/artifact-types/{artifact_type_id}/artifacts/{artifact_id}/documents/{document_id}	POST	Adds an existing attachment to the specified artifact.
projects/{project_id}/artifact-types/{artifact_type_id}/artifacts/{artifact_id}/documents/{document_id}	DELETE	Deletes an attachment from an artifact. The attachment will still remain in the project
> Export to Rapise .REST File

Association

URI	Method	Description
projects/{project_id}/associations	POST	Adds a new association in the system
projects/{project_id}/associations	PUT	Updates the specified Association's information
projects/{project_id}/associations/{artifact_type_id}/{artifact_id}	GET	Retrieves a set of associations to the specified artifact
> Export to Rapise .REST File

Automation Engine

URI	Method	Description
automation-engines	POST	Creates a new Automation Engine in the system.
automation-engines/{automation_engine_id}	GET	Retrieves a single automation engine record by its ID
automation-engines/tokens{token}	GET	Retrieves a single automation engine record by its Token
automation-engines?active_only={active_only}	GET	Retrieves the list of automation engines in the system
> Export to Rapise .REST File

Automation Host

URI	Method	Description
projects/{project_id}/automation-hosts	GET	Retrieves the list of all the automation hosts in the current project
projects/{project_id}/automation-hosts	POST	Creates a new automation host in the system
projects/{project_id}/automation-hosts	PUT	Updates an automation host in the system
projects/{project_id}/automation-hosts/{automation_host_id}	GET	Retrieves a single automation host by its id
projects/{project_id}/automation-hosts/{automation_host_id}	DELETE	Deletes a automation host in the system
projects/{project_id}/automation-hosts/search?starting_row={starting_row}&number_of_rows={number_of_rows}&sort_field={sort_field}&sort_direction={sort_direction}	POST	Retrieves the list of automation hosts in the current project
projects/{project_id}/automation-hosts/tokens/{token}	GET	Retrieves a single automation host by its token name
> Export to Rapise .REST File

Custom List

URI	Method	Description
projects/{project_id}/custom-lists	POST	Adds a new custom list into the project
projects/{project_id}/custom-lists	GET	Retrieves all the custom lists in the current project
projects/{project_id}/custom-lists/{custom_list_id}	GET	Retrieves a custom list by its ID, including any custom list values
projects/{project_id}/custom-lists/{custom_list_id}	PUT	Updates a custom list and any associated values in the system
> Export to Rapise .REST File

Custom List Value

URI	Method	Description
projects/{project_id}/custom-lists/{custom_list_id}/values	POST	Adds a new custom property list value into the system
> Export to Rapise .REST File

Custom Property

URI	Method	Description
projects/{project_id}/custom-properties/{artifact_type_name}	GET	Retrieves the list of custom properties configured for the current project and the specified artifact type
projects/{project_id}/custom-properties/{custom_property_id}	PUT	Updates a custom property definition, including any associated options
projects/{project_id}/custom-properties/{custom_property_id}	DELETE	Deletes a custom property definition from the system, including any associated options
projects/{project_id}/custom-properties?custom_list_id={custom_list_id}	POST	Adds a new custom property definition to the project for the specified artifact type
> Export to Rapise .REST File

Data Mapping Artifacts

URI	Method	Description
projects/{project_id}/data-mappings/{data_sync_system_id}/artifacts/{artifact_type_id}	GET	Retrieves a list of data mappings for artifact ids in the system
projects/{project_id}/data-mappings/{data_sync_system_id}/artifacts/{artifact_type_id}	POST	Adds new artifact data mapping entries
projects/{project_id}/data-mappings/{data_sync_system_id}/artifacts/{artifact_type_id}	DELETE	Removes existing artifact data mapping entries
> Export to Rapise .REST File

Data Mapping Custom Properties

URI	Method	Description
projects/{project_id}/data-mappings/{data_sync_system_id}/artifacts/{artifact_type_id}/custom-properties/{custom_property_id}	GET	Retrieves the data mapping for a custom property
> Export to Rapise .REST File

Data Mapping Custom Property Values

URI	Method	Description
projects/{project_id}/data-mappings/{data_sync_system_id}/artifacts/{artifact_type_id}/custom-properties/{custom_property_id}/values	GET	Retrieves a list of data mappings for custom property values
> Export to Rapise .REST File

Data Mapping Field Values

URI	Method	Description
projects/{project_id}/data-mappings/{data_sync_system_id}/field-values/{artifact_field_id}	GET	Retrieves a list of data mappings for artifact field values
> Export to Rapise .REST File

Data Mapping Projects

URI	Method	Description
data-mappings/{data_sync_system_id}/projects	GET	Retrieves a list of data mappings for projects in the system
> Export to Rapise .REST File

Data Mapping Users

URI	Method	Description
data-mappings/{data_sync_system_id}/users	POST	Adds new user data mapping entries
data-mappings/{data_sync_system_id}/users	GET	Retrieves a list of data mappings for users in the system
> Export to Rapise .REST File

Data Sync

URI	Method	Description
data-syncs	GET	Retrieves a list of data-sync plug-ins that need to be synchronized with
data-syncs/{data_sync_system_id}/failure	POST	Updates the status for a failed data-sync plug-in
data-syncs/{data_sync_system_id}/success	POST	Updates the status for a successful data-sync plug-in
data-syncs/{data_sync_system_id}/warning	POST	Updates the status for a data-sync plug-in that executed with warnings
> Export to Rapise .REST File

Data Sync Event

URI	Method	Description
data-syncs/events	POST	Writes an error/warning event entry to the SpiraTeam database log
> Export to Rapise .REST File

Document

URI	Method	Description
projects/{project_id}/document-folders/{folder_id}/documents/search?start_row={start_row}&number_rows={number_rows}&sort_by={sort_by}	POST	Retrieves a filtered list of documents/attachments in a project for the specified folder
projects/{project_id}/documents	GET	Retrieves a list of all the documents/attachments in a project across all folders
projects/{project_id}/documents/{document_id}	DELETE	Deletes an attachment from the project completely
projects/{project_id}/documents/{document_id}	GET	Retrieves a single project document by its id
projects/{project_id}/documents/{document_id}/open	GET	Returns the actual binary content of a file attachment in the system
projects/{project_id}/documents/file?filename={filename}&tags={tags}&folder_id={folder_id}&document_type_id={document_type_id}&artifact_type_id={artifact_type_id}&artifact_id={artifact_id}	POST	Adds a new document (file) into the system and associates it with the provided artifact (optional) and project folder/type (optional)
projects/{project_id}/documents/search?start_row={start_row}&number_rows={number_rows}&sort_by={sort_by}	POST	Retrieves a filtered list of documents/attachments in a project across all folders
projects/{project_id}/documents/url?url={url}&tags={tags}&folder_id={folder_id}&document_type_id={document_type_id}&artifact_type_id={artifact_type_id}&artifact_id={artifact_id}	POST	Adds a new document (url) into the system and associates it with the provided artifact (optional) and project folder/type (optional)
> Export to Rapise .REST File

Document Folder

URI	Method	Description
projects/{project_id}/document-folders	GET	Retrieves a list of all the document folders in the current project
projects/{project_id}/document-folders	POST	Adds a new document folder into the current project
projects/{project_id}/document-folders/{folder_id}	GET	Retrieves the folder by the specified ID.
projects/{project_id}/document-folders/{folder_id}	DELETE	Deletes an existing document folder from the current project
projects/{project_id}/document-folders/{folder_id}	PUT	Updates the name and position of an existing folder in the project
> Export to Rapise .REST File

Document Type

URI	Method	Description
projects/{project_id}/document-types?active_only={active_only}	GET	Retrieves a list of all the document types in the current project
> Export to Rapise .REST File

Document Version

URI	Method	Description
projects/{project_id}/documents/{document_id}/versions/file?filename={filename}&version={version}&make_current={make_current}	POST	Adds a new version to a file attachment in the system
projects/{project_id}/documents/{document_id}/versions/url?url={url}&version={version}&make_current={make_current}	POST	Adds a new version to a URL attachment in the system
> Export to Rapise .REST File

Incident

URI	Method	Description
projects/{project_id}/incidents	GET	Retrieves the list of incidents in the project, ordered by the most recent. Only returns the first 500 results
projects/{project_id}/incidents	POST	Creates a new incident in the specified project in the system
projects/{project_id}/incidents/{incident_id}	GET	Retrieves a single incident in the system
projects/{project_id}/incidents/{incident_id}	PUT	Updates an incident already present in the system.
projects/{project_id}/incidents/{incident_id}	DELETE	Deletes an incident in a specific project in the system
projects/{project_id}/incidents/count	GET	Returns the count of the number of incidents in the project
projects/{project_id}/incidents/recent?start_row={start_row}&number_rows={number_rows}&creation_date={creation_date}	GET	Retrieves all new incidents added in the system since the date specified
projects/{project_id}/incidents/search?start_row={start_row}&number_rows={number_rows}&sort_by={sort_by}	GET	Retrieves the list of incidents in the project. This operation allows you to specify the sort column and the pagination range
projects/{project_id}/incidents/search?start_row={start_row}&number_rows={number_rows}&sort_by={sort_by}	POST	Searches the list of incidents in the project. This operation allows you to specify a list of filters, the sort column and the pagination range
projects/{project_id}/incidents/search-by-ids?ids={incident_ids}	GET	Retrieves a list of incidents that match the comma-separated list of ids
> Export to Rapise .REST File

Incident Comment

URI	Method	Description
projects/{project_id}/incidents/{incident_id}/comments	GET	Retrieves a list of comments that belong to the specified incident
projects/{project_id}/incidents/{incident_id}/comments	POST	Adds new incident comments to an incident in a project in the system
> Export to Rapise .REST File

Incident Priority

URI	Method	Description
projects/{project_id}/incidents/priorities	GET	Retrieves a list of the active incident priorities for the current project
projects/{project_id}/incidents/priorities	POST	Creates a new incident priority in the specified project in the system
> Export to Rapise .REST File

Incident Severity

URI	Method	Description
projects/{project_id}/incidents/severities	GET	Retrieves a list of the active incident severities for the current project
projects/{project_id}/incidents/severities	POST	Creates a new incident severity in the specified project in the system
> Export to Rapise .REST File

Incident Status

URI	Method	Description
projects/{project_id}/incidents/statuses	GET	Retrieves a list of the active incident statuses for the current project
projects/{project_id}/incidents/statuses	POST	Creates a new incident status in the specified project in the system
projects/{project_id}/incidents/statuses/default	GET	Retrieves the default incident status for the current project
> Export to Rapise .REST File

Incident Type

URI	Method	Description
projects/{project_id}/incidents/types	POST	Creates a new incident type in the specified project in the system
projects/{project_id}/incidents/types	GET	Retrieves a list of the active incident types for the current project
projects/{project_id}/incidents/types/{incident_type_id}/workflow/custom-properties?status_id={incident_status_id}	GET	Retrieves the list of incident custom properties and their workflow state for a given type and status/step.
projects/{project_id}/incidents/types/{incident_type_id}/workflow/fields?status_id={incident_status_id}	GET	Retrieves the list of incident fields and their workflow status for a given type and status/step.
projects/{project_id}/incidents/types/{incident_type_id}/workflow/transitions?status_id={incident_status_id}&is_detector={is_detector}&isOwner={is_owner}	GET	Will retrieve available transitions for the specied status ID for the currently logged-on user.
projects/{project_id}/incidents/types/default	GET	Retrieves the default incident type for the current project
> Export to Rapise .REST File

Project

URI	Method	Description
projects	GET	Retrieves a list of projects that the authenticated user has access to
projects/{project_id}	GET	Retrieves a single project in the system
projects/{project_id}	DELETE	Deletes an existing project in the system
projects/{project_id}/refresh-caches/{release_id}?run_async={run_async}	POST	Refreshes the task progress and test execution status for a project. Typically this needs to be called after TestRun_RecordAutomated3(...) API calls to ensure the data in the system is consistent
projects?existing_project_id={existing_project_id}	POST	Creates a new project in the system and makes the authenticated user owner of it
> Export to Rapise .REST File

Project Role

URI	Method	Description
projects-roles	GET	Retrieves a list of project roles in the system
> Export to Rapise .REST File

Project User

URI	Method	Description
projects/{project_id}/users	GET	Retrieves the list of active users that are members of the current project
> Export to Rapise .REST File

Release

URI	Method	Description
projects/{project_id}/releases	GET	Retrieves all the releases belonging to the current project
projects/{project_id}/releases	POST	Creates a new release in the system at the root level
projects/{project_id}/releases	PUT	Updates a release in the system
projects/{project_id}/releases/{parent_release_id}	POST	Creates a new release in the system under a specified parent release
projects/{project_id}/releases/{release_id}	GET	Retrieves a single release in the system
projects/{project_id}/releases/{release_id}	DELETE	Deletes a release in the system
projects/{project_id}/releases/{release_id}/move?destination_release_id={destination_release_id}	POST	Moves a release to another location in the hierarchy
projects/{project_id}/releases/count	POST	Returns the number of releases that match the filter.
projects/{project_id}/releases/search?start_row={start_row}&number_rows={number_rows}	POST	Retrieves a list of releases in the system that match the provided filter
> Export to Rapise .REST File

Release Build

URI	Method	Description
projects/{project_id}/releases/{release_id}/builds	GET	Retrieves the list of builds that are associated with a specific Release
projects/{project_id}/releases/{release_id}/builds	POST	Creates a new build in the system, including any linked source code revisions
projects/{project_id}/releases/{release_id}/builds/{build_id}	GET	Retrieves the a single build (and associated source code revisions) by its id
> Export to Rapise .REST File

Release Comments

URI	Method	Description
projects/{project_id}/releases/{release_id}/comments	GET	Retrieves comments for a specified release.
projects/{project_id}/releases/{release_id}/comments	POST	Creates a new comment for a release.
> Export to Rapise .REST File

Release Test Cases

URI	Method	Description
projects/{project_id}/releases/{release_id}/test-cases	POST	Maps a release to a test case, so that the test case is needs to be tested for that release
projects/{project_id}/releases/{release_id}/test-cases	GET	Retrieves the mapped test cases for a specific release
projects/{project_id}/releases/{release_id}/test-cases/{test_case_id}	DELETE	Removes a mapping entry for a specific release and test case
projects/{project_id}/releases/{release_id}/test-cases/search?starting_row={starting_row}&number_of_rows={number_of_rows}	POST	Retrieves a list of testCases in a particular release that match the provided filter
> Export to Rapise .REST File

Requirement

URI	Method	Description
projects/{project_id}/requirements	POST	Creates a new requirement record in the current project at the end of the list
projects/{project_id}/requirements	PUT	Updates a requirement in the system
projects/{project_id}/requirements/{requirement_id}	GET	Retrieves a single requirement in the system
projects/{project_id}/requirements/{requirement_id}	DELETE	Deletes a requirement in the system
projects/{project_id}/requirements/{requirement_id}/indent	POST	Indents a requirement one position
projects/{project_id}/requirements/{requirement_id}/move/{destination_requirement_id}	POST	Moves a requirement to another location in the hierarchy
projects/{project_id}/requirements/{requirement_id}/outdent	POST	Outdents a requirement one position
projects/{project_id}/requirements/count	GET	Returns the number of requirements that match the filter.
projects/{project_id}/requirements/count	POST	Returns the number of requirements that match the filter.
projects/{project_id}/requirements/indent/{indent_position}	POST	Creates a new requirement record in the current project using the position offset method
projects/{project_id}/requirements/parent/{parent_requirement_id}	POST	Creates a new requirement in the system
projects/{project_id}/requirements/search?starting_row={starting_row}&number_of_rows={number_of_rows}	POST	Retrieves a list of requirements in the system that match the provided filter
projects/{project_id}/requirements?starting_row={starting_row}&number_of_rows={number_of_rows}	GET	Retrieves a list of requirements in the system
requirements	GET	Retrieves all requirements owned by the currently authenticated user
> Export to Rapise .REST File

Requirement Comment

URI	Method	Description
projects/{project_id}/requirements/{requirement_id}/comments	GET	Retrieves comments for a specified requirement.
projects/{project_id}/requirements/{requirement_id}/comments	POST	Creates a new comment for a requirement.
> Export to Rapise .REST File

Requirement Test Coverage

URI	Method	Description
projects/{project_id}/requirements/{requirement_id}/test-cases	GET	Retrieves the test coverage for a specific requirement
projects/{project_id}/requirements/test-cases	POST	Maps a requirement to a test case, so that the test case 'covers' the requirement
projects/{project_id}/requirements/test-cases	DELETE	Removes a coverage mapping entry for a specific requirement and test case
> Export to Rapise .REST File

System

URI	Method	Description
system/productVersion	GET	Retrieves the version number of the current installation.
> Export to Rapise .REST File

Task

URI	Method	Description
projects/{project_id}/tasks	POST	Creates a new task in the system
projects/{project_id}/tasks	PUT	Updates a task in the system
projects/{project_id}/tasks/{task_id}	GET	Retrieves a single task in the system
projects/{project_id}/tasks/{task_id}	DELETE	Deletes a task in the system
projects/{project_id}/tasks/{task_id}/comments	POST	Creates a new comment for a task.
projects/{project_id}/tasks/count	GET	Returns the number of tasks in the project.
projects/{project_id}/tasks/count	POST	Returns the number of tasks that match the filter.
projects/{project_id}/tasks/new?creation_date={creation_date}&start_row={start_row}&number_of_rows={number_of_rows}	GET	Retrieves all new tasks added in the system since the date specified
projects/{project_id}/tasks?starting_row={starting_row}&number_of_rows={number_of_rows}&sort_field={sort_field}&sort_direction={sort_direction}	POST	Retrieves a list of tasks in the system that match the provided filter/sort
tasks	GET	Retrieves all tasks owned by the currently authenticated user
> Export to Rapise .REST File

Task Comment

URI	Method	Description
projects/{project_id}/tasks/{task_id}/comments	GET	Retrieves comments for a specified task.
> Export to Rapise .REST File

Test Case

URI	Method	Description
projects/{project_id}/test-cases	PUT	Updates a test case in the system together with its test steps (if populated)
projects/{project_id}/test-cases/{test_case_id}	GET	Retrieves a single test case/folder in the system
projects/{project_id}/test-cases/{test_case_id}	DELETE	Deletes a test case in the system
projects/{project_id}/test-cases/{test_case_id}/add-update-automation-script?automation_engine_id={automation_engine_id}&url_or_filename={url_or_filename}&description={description}&version={version}&project_attachment_type_id={project_attachment_type_id}&project_attachment_folder_id={project_attachment_folder_id}	POST	Adds or updates the automation test script associated with a test case
projects/{project_id}/test-cases/{test_case_id}/move?destination_test_case_folder_id={destination_test_case_folder_id}	POST	Moves a test case to another location in the hierarchy
projects/{project_id}/test-cases/count	GET	Returns the number of test cases in the project
projects/{project_id}/test-cases/count	POST	Returns the number of test cases that match the filter.
projects/{project_id}/test-cases/search?starting_row={starting_row}&number_of_rows={number_of_rows}	POST	Retrieves a list of testCases in the system that match the provided filter
projects/{project_id}/test-cases/search?starting_row={starting_row}&number_of_rows={number_of_rows}	GET	Retrieves a list of testCases in the project
projects/{project_id}/test-cases?parent_test_folder_id={parent_test_folder_id}	POST	Creates a new test case in the system
projects/{project_id}/test-folders/{test_case_folder_id}/test-cases	GET	Retrieves all test cases that are stored in a particular test folder
test-cases	GET	Retrieves all testCases owned by the currently authenticated user
> Export to Rapise .REST File

Test Case Comment

URI	Method	Description
projects/{project_id}/test-cases/{test_case_id}/comments	GET	Retrieves comments for a specified test case.
projects/{project_id}/test-cases/{test_case_id}/comments	POST	Creates a new comment for a test case.
> Export to Rapise .REST File

Test Case Folder

URI	Method	Description
projects/{project_id}/test-folders/{test_folder_id}/count	GET	Gives a count of items within the given folder
projects/{project_id}/test-folders/{test_folder_id}/count	POST	Gives a count of items within the given folder that match the filters.
projects/{project_id}/test-folders?parent_test_folder_id={parent_test_folder_id}	POST	Creates a new test case folder in the system
> Export to Rapise .REST File

Test Case Link

URI	Method	Description
projects/{project_id}/test-cases/{test_case_id}/test-links/{linked_test_case_id}?position={position}	POST	Adds a new test step that is actually a link to a test case
> Export to Rapise .REST File

Test Case Parameter

URI	Method	Description
projects/{project_id}/test-cases/{test_case_id}/parameters	GET	Retrieves the list of defined parameters for a test case along with the associated default value
projects/{project_id}/test-cases/parameters	POST	Adds a new parameter for a test case
projects/{project_id}/test-cases/parameters/create-token?parameter_name={parameter_name}	POST	Returns the full token of a test case parameter from its name
> Export to Rapise .REST File

Test Run

URI	Method	Description
projects/{project_id}/test-runs/{test_run_id}	GET	Retrieves a single test run in the system. Only returns the generic information that is applicable for both automated and manual tests. Consider using TestRun_RetrieveAutomatedById or TestRun_RetrieveManualById if you need the automation/manual specific data for the test run
projects/{project_id}/test-runs/{test_run_id}/automated	GET	Retrieves a single automated test run in the system including the automation-specific information
projects/{project_id}/test-runs/{test_run_id}/manual	GET	Retrieves a single manual test run in the system including any associated steps
projects/{project_id}/test-runs/automated??starting_row={starting_row}&number_of_rows={number_of_rows}&sort_field={sort_field}&sort_direction={sort_direction}	GET	Retrieves a list of automated test runs in the project
projects/{project_id}/test-runs/count	GET	Returns the number of test runs in the project.
projects/{project_id}/test-runs/count	POST	Returns the number of test runs that match the filter.
projects/{project_id}/test-runs/create/automation_host/{automation_host_token}	POST	Creates a shell set of test runs for an external automated test runner based on the provided automation host token and the specified date range
projects/{project_id}/test-runs/create/test_set/{test_set_id}	POST	Creates a new test run shell from the provided test set
projects/{project_id}/test-runs/create/test_set/{test_set_id}/automation_host/{automation_host_token}	POST	Creates a shell set of test runs for an external automated test runner based on the provided test set id
projects/{project_id}/test-runs/create?release_id={release_id}	POST	Creates a new test run shell from the provided test case(s)
projects/{project_id}/test-runs/manual?starting_row={starting_row}&number_of_rows={number_of_rows}&sort_field={sort_field}&sort_direction={sort_direction}	GET	Retrieves a list of manual test runs in the project
projects/{project_id}/test-runs/record	POST	Records the results of executing an automated test
projects/{project_id}/test-runs/record-multiple	POST	Records the results of executing multiple automated tests
projects/{project_id}/test-runs/search/automated??starting_row={starting_row}&number_of_rows={number_of_rows}&sort_field={sort_field}&sort_direction={sort_direction}	POST	Retrieves a list of automated test runs in the system that match the provided filter/sort
projects/{project_id}/test-runs/search/manual?starting_row={starting_row}&number_of_rows={number_of_rows}&sort_field={sort_field}&sort_direction={sort_direction}	POST	Retrieves a list of manual test runs in the system that match the provided filter/sort
projects/{project_id}/test-runs/search?starting_row={starting_row}&number_of_rows={number_of_rows}&sort_field={sort_field}&sort_direction={sort_direction}	POST	Retrieves a list of test runs in the system that match the provided filter/sort
projects/{project_id}/test-runs?end_date={end_date}	PUT	Saves set of test runs, each containing test run steps
projects/{project_id}/test-runs?starting_row={starting_row}&number_of_rows={number_of_rows}&sort_field={sort_field}&sort_direction={sort_direction}	GET	Retrieves a list of test runs in the project
> Export to Rapise .REST File

Test Set

URI	Method	Description
projects/{project_id}/test-sets	GET	Retrieves a list of testSets in the current project
projects/{project_id}/test-sets/	PUT	Updates a test set in the system
projects/{project_id}/test-sets/{test_set_id}	GET	Retrieves a single test set/folder in the system
projects/{project_id}/test-sets/{test_set_id}	DELETE	Deletes a test set in the system
projects/{project_id}/test-sets/{test_set_id}/move?destination_test_set_folder_id={destination_test_set_folder_id}	POST	Moves a test set to another location in the hierarchy
projects/{project_id}/test-sets/count	GET	Returns the number of test sets in the project
projects/{project_id}/test-sets/count	POST	Returns the number of test sets that match the filter.
projects/{project_id}/test-sets/search?starting_row={starting_row}&number_of_rows={number_of_rows}	POST	Retrieves a list of testSets in the system that match the provided filter
projects/{project_id}/test-sets?parent_test_set_folder_id={parent_test_set_folder_id}	POST	Creates a new test set in the system
test-sets	GET	Retrieves all testSets owned by the currently authenticated user
> Export to Rapise .REST File

Test Set Comment

URI	Method	Description
projects/{project_id}/test-sets/{test_set_id}/comments	GET	Retrieves comments for a specified test set.
projects/{project_id}/test-sets/{test_set_id}/comments	POST	Creates a new comment for a test set.
> Export to Rapise .REST File

Test Set Folder

URI	Method	Description
projects/{project_id}/test-set-folders?parent_test_set_folder_id={parent_test_set_folder_id}	POST	Creates a new test set folder in the system
> Export to Rapise .REST File

Test Set Test Case

URI	Method	Description
projects/{project_id}/test-sets/{test_set_id}/test-case-mapping	GET	Retrieves all the test cases that are part of a test set
projects/{project_id}/test-sets/{test_set_id}/test-case-mapping/{test_case_id}?owner_id={owner_id}&existing_test_set_test_case_id={existing_test_set_test_case_id}	POST	Maps a test set to a test case, so that the test case is part of the test set
projects/{project_id}/test-sets/{test_set_id}/test-cases	GET	Retrieves all the test cases that are part of a test set
projects/{project_id}/test-sets/{test_set_id}/test-cases/{test_set_test_case_id}	DELETE	Removes a test case from a test set
> Export to Rapise .REST File

Test Step

URI	Method	Description
projects/{project_id}/test-cases/{test_case_id}/test-steps	POST	Adds a new test step to the specified test case
projects/{project_id}/test-cases/{test_case_id}/test-steps/{source_test_step_id}/move?destination_test_step_id={destination_test_step_id}	POST	Moves a test step to a different position in the test case
projects/{project_id}/test-cases/{test_case_id}/test-steps/{test_step_id}	DELETE	Deletes a test step in the system
> Export to Rapise .REST File

Test Step Parameter

URI	Method	Description
projects/{project_id}/test-cases/{test_case_id}/test-steps/{test_step_id}/parameters	GET	Retrieves the list of parameters and provided values for a test link step
> Export to Rapise .REST File

User

URI	Method	Description
users	GET	Retrieves the details of the current, authenticated user
users/{user_id}	GET	Retrieves a single user in the system
users/{user_id}	DELETE	Tries to delete the specified user ID. Note that this function will fail if any other foreign keys (fields) in other tables are assigned to the user that is specified.) Must be connected to the API as the root Administrator.
users/usernames/{user_name}	GET	Retrieves a single user in the system by user-name
users?password={password}&password_question={password_question}&password_answer={password_answer}&project_id={project_id}&project_role_id={project_role_id}	POST	Creates a new user in the system and adds them to the current project as the specified role
> Export to Rapise .REST File