See all operations
GET: system/custom-properties/{artifact_type_name}
Description
Retrieves the list of custom properties configured for the current project template and the specified artifact type
1) Includes the custom list and custom list value child objects
2) The custom list values objects will include both active and inactive values, so need to check the flag before displaying
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-properties/{artifact_type_name}
Request Parameters
|
Name
|
Description
|
|
artifact_type_name
|
The name of the type of artifact ('Project', 'ProgramMilestone', 'Capability', etc.)
|
Request Body
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.
<ArrayOfRemoteSystemCustomProperty xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v7_0.DataObjects">
<RemoteSystemCustomProperty>
<ConcurrencyGuid i:nil="true" />
<Guid i:nil="true" />
<LastUpdateDate i:nil="true" />
<ArtifactTypeId>0</ArtifactTypeId>
<CustomList i:nil="true" />
<CustomPropertyFieldName i:nil="true" />
<CustomPropertyId i:nil="true" />
<CustomPropertyTypeId>0</CustomPropertyTypeId>
<CustomPropertyTypeName i:nil="true" />
<Description i:nil="true" />
<IsDeleted>false</IsDeleted>
<Name i:nil="true" />
<Options i:nil="true" />
<Position i:nil="true" />
<PropertyNumber>0</PropertyNumber>
<SystemDataType i:nil="true" />
</RemoteSystemCustomProperty>
</ArrayOfRemoteSystemCustomProperty>
[{"CustomPropertyId":null,
"ArtifactTypeId":0,
"Name":null,
"CustomList":null,
"CustomPropertyFieldName":null,
"CustomPropertyTypeId":0,
"CustomPropertyTypeName":null,
"IsDeleted":false,
"PropertyNumber":0,
"SystemDataType":null,
"Options":null,
"Position":null,
"Description":null,
"Guid":null,
"ConcurrencyGuid":null,
"LastUpdateDate":null}]