See all operations

GET: system/custom-lists/{custom_list_id}

Description

Retrieves a custom list by its ID, including any custom list values

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/{custom_list_id}

Request Parameters

Name	Description
custom_list_id	The id of the custom list we want to retrieve

Request Body

Nothing Expected

Nothing Expected

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
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}