SpiraPlan: SoapService SOAP Web Service

See all operations

CustomProperty_RetrieveForArtifactType

Description

Retrieves the list of custom properties configured for the current project 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

Example(s)

            RemoteCustomProperty[] remoteCustomProperties = spiraImportExport.CustomProperty_RetrieveForArtifactType(credentials, projectTemplateId, (int)DataModel.Artifact.ArtifactTypeEnum.Requirement, false);
            

Parameters

Type Name Required
RemoteCredentials? credentials - The API credentials
intprojectTemplateId - The id of the project template Yes
intartifactTypeId - The id of the type of artifact Yes
booleanincludeDeleted - Should we include deleted custom properties Yes

Return Value

ArrayOfRemoteCustomProperty - The list of custom properties