SpiraPlan: SoapService SOAP Web Service

See all operations

CustomProperty_AddDefinition

Description

Adds a new custom property definition to the project for the specified artifact type

Example(s)

            RemoteCustomProperty remoteCustomProperty = new RemoteCustomProperty();
            remoteCustomProperty.ArtifactTypeId = (int)DataModel.Artifact.ArtifactTypeEnum.Requirement;
            remoteCustomProperty.ProjectId = projectId1;
            remoteCustomProperty.PropertyNumber = 2;
            remoteCustomProperty.CustomPropertyTypeId = 6;  //List
            remoteCustomProperty.Name = "Req Type";
            spiraImportExport.CustomProperty_AddDefinition(credentials, remoteCustomProperty, remoteCustomList.CustomPropertyListId);

Parameters

Type Name Required
RemoteCredentials? credentials - The credentials for accessing the API
RemoteCustomProperty? remoteCustomProperty - The new custom property definition
int? customListId - The id of the associated custom list (if a list property)

Return Value

RemoteCustomProperty - The custom property definition with the primary key populated