SpiraTeam: REST Web Service (v5.0)

See all operations

PUT: projects/{project_id}/custom-lists/{custom_list_id}

Description

Updates a custom list and any associated values in the system

This will not add any new custom values, for that you need to use the AddCustomListValue() function

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):

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

Request Parameters

Name Description
project_id The id of the current project
custom_list_id The id of the list being updated

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.