SpiraTeam: REST Web Service (v5.0)

See all operations

PUT: projects/{project_id}/custom-properties/{custom_property_id}

Description

Updates a custom property definition, including any associated options

This method updates the custom property Name, IsDeleted flag, and custom property options, but does not update the list values or other fields. To change the list values, you need to use: CustomProperty_UpdateCustomList(...)

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

http://api.inflectra.com/Spira/Services/v5_0/RestService.svc/projects/{project_id}/custom-properties/{custom_property_id}

Request Parameters

Name Description
project_id The id of the current project
custom_property_id The id of the custom property

Request Body

Property Description
CustomPropertyId The id of the custom property (leave null for newly created ones)
ProjectId The project the custom property belongs to
ArtifactTypeId The artifact type that the custom property is for
Name The display name for the custom property
CustomList The associated custom list if this is a list custom property This will be null if this is not a list custom property
CustomPropertyFieldName The internal field name of the custom property (e.g. Custom_01)
CustomPropertyTypeId The type of custom property. It can have the following values: Text = 1, Integer = 2, Decimal = 3, Boolean = 4, Date = 5, List = 6, MultiList = 7, User = 8
CustomPropertyTypeName The display name of the type of custom property
IsDeleted Has this custom property been deleted
PropertyNumber The position number of this custom property (1-30). Each artifact type can have 30 custom properties per project
SystemDataType The physical data type that this custom property is stored as (Int32, String, DataTime, etc.)
Options The collection of custom property options

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.