SpiraPlan: REST Web Service (v7.0)

See all operations

POST: programs/{program_id}/capabilities/search?starting_row={starting_row}&number_of_rows={number_of_rows}&sort_field={sort_field}&sort_direction={sort_direction}


Retrieves a sorted list of capabilities in a given program that match the provided filter

How to Execute

To access this REST web service, you need to use the following URL (make sure to replace any parameters (eg {project_id}) with the relevant value (eg 1):


Request Parameters

Name Description
program_id ID of the program to retrieve capabilities from
starting_row What row to start retrieving from (starts at 1)
number_of_rows Number of rows to retrieve
sort_field What field to sort on (If left blank, the default is CapabilityId)
sort_direction Whether or not to sort ascending

Request Body

Property Description

Return Data

The JSON and XML examples below show the shape of one entry that will be returned. It does not show an example of how that entry will be populated.

Property Description