SpiraTeam: REST Web Service (v4.0)

See all operations

POST: projects/{project_id}/custom-lists

Description

Adds a new custom list into the project

Also adds any custom list values if they are provided

How to Execute

To access this REST web service, you need to use the following URL:

http://api.inflectra.com/Spira/Services/v4_0/RestService.svc/projects/{project_id}/custom-lists

Request Parameters

Name Description
project_id The id of the current project

Request Body

Property Description
CustomPropertyListId The id of the custom list
ProjectId The id of the project the custom list belongs to
Name The name of the custom list
Active Whether the list is active or not
SortedOnValue Whether the list is sorted on value or not
Values The collection of values in the custom list

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
CustomPropertyListId The id of the custom list
ProjectId The id of the project the custom list belongs to
Name The name of the custom list
Active Whether the list is active or not
SortedOnValue Whether the list is sorted on value or not
Values The collection of values in the custom list