See all operations
POST: project-templates/{project_template_id}/custom-lists/{custom_list_id}/values
Description
Adds a new custom property list value into the system
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/project-templates/{project_template_id}/custom-lists/{custom_list_id}/values
Request Parameters
Name
|
Description
|
project_template_id
|
The id of the current project template
|
custom_list_id
|
The id of the custom list
|
Request Body
Property
|
Description
|
CustomPropertyValueId
|
The id of the custom list value
|
CustomPropertyListId
|
The id of the custom list the value belongs to
|
Name
|
The name of the custom list value
|
Active
|
Is the custom list value active or not
|
ParentCustomPropertyValueId
|
The id of any parent custom list value
|
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
|
<RemoteCustomListValue 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>0</CustomPropertyListId>
<CustomPropertyValueId i:nil="true" />
<Name i:nil="true" />
<ParentCustomPropertyValueId i:nil="true" />
</RemoteCustomListValue>
{"CustomPropertyValueId":null,
"CustomPropertyListId":0,
"Name":null,
"Active":false,
"ParentCustomPropertyValueId":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.
Property
|
Description
|
CustomPropertyValueId
|
The id of the custom list value
|
CustomPropertyListId
|
The id of the custom list the value belongs to
|
Name
|
The name of the custom list value
|
Active
|
Is the custom list value active or not
|
ParentCustomPropertyValueId
|
The id of any parent custom list value
|
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
|
<RemoteCustomListValue 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>0</CustomPropertyListId>
<CustomPropertyValueId i:nil="true" />
<Name i:nil="true" />
<ParentCustomPropertyValueId i:nil="true" />
</RemoteCustomListValue>
{"CustomPropertyValueId":null,
"CustomPropertyListId":0,
"Name":null,
"Active":false,
"ParentCustomPropertyValueId":null,
"Guid":null,
"ConcurrencyGuid":null,
"LastUpdateDate":null}