See all operations

PUT: system/custom-lists

Description

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

https://api.inflectra.com/Spira/Services/v7_0/RestService.svc/system/custom-lists

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

<RemoteSystemCustomList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v7_0.DataObjects">
  <ConcurrencyGuid i:nil="true" />
  <Guid i:nil="true" />
  <LastUpdateDate i:nil="true" />
  <Active>false</Active>
  <CustomPropertyListId i:nil="true" />
  <Name i:nil="true" />
  <SortedOnValue>false</SortedOnValue>
  <Values i:nil="true" />
</RemoteSystemCustomList>

{"CustomPropertyListId":null,
"Name":null,
"Active":false,
"SortedOnValue":false,
"Values":null,
"Guid":null,
"ConcurrencyGuid":null,
"LastUpdateDate":null}

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.

Nothing Returned

Nothing Returned