SpiraPlan: REST Web Service (v7.0)

See all operations

PUT: system/custom-lists


Updates a system custom list's name, active status, and/or sort option (SortedOnValue = true sorts alphabetically, SortedOnValue = false sorts by ID)

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 Body

Property Description
CustomPropertyListId The id of the custom list
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
Guid The unique identifier for the artifact
ConcurrencyGuid GUID for representing the concurrency state of a given artifact
LastUpdateDate Last time the artifact was updated

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.