Knowledge Base Article

Home Page > Knowledge Base > Spira Platform

Home Page > Knowledge Base > Spira Platform > SpiraPlan

Home Page > Knowledge Base > Spira Platform > SpiraTeam

Home Page > Knowledge Base > Spira Platform > SpiraTest

Article List of Possible Filterable Field Names in Spira when Using API

by Adam S on Thursday, September 11, 2014

When you use our SOAP or REST web service APIs you will often times want to retrieve a filtered list of data. This is done by using the RemoteFilter that lets you query the list of requirements, test cases, tasks, incidents, etc. and pass in the field to be filtered. This article includes the list of standard fields that you can use in the RemoteFilter.

The following standard fields can be used with RemoteFilter on SpiraTeam v4.1 or later:

Artifact TypeField CaptionProperty Name
RequirementAuthorAuthorId
RequirementCommentsComments
RequirementComponentComponentId
RequirementTest CoverageCoverageId
RequirementCreated OnCreationDate
RequirementDescriptionDescription
RequirementEst. EffortEstimatedEffort
RequirementEstimateEstimatePoints
RequirementImportanceImportanceId
RequirementLast ModifiedLastUpdateDate
RequirementRequirement NameName
RequirementOwnerOwnerId
RequirementTask ProgressProgressId
RequirementReleaseReleaseId
RequirementRequirement #RequirementId
RequirementStatusRequirementStatusId
RequirementTypeRequirementTypeId
RequirementActual EffortTaskActualEffort
RequirementTask EffortTaskEstimatedEffort
RequirementProjected EffortTaskProjectedEffort
RequirementRemaining EffortTaskRemainingEffort
Test CaseActiveActiveYn
Test CaseAuthorAuthorId
Test CaseAutomation EngineAutomationEngineId
Test CaseCommentsComments
Test CaseCreated OnCreationDate
Test CaseDescriptionDescription
Test CaseEst. DurationEstimatedDuration
Test CaseLast ExecutedExecutionDate
Test CaseExecution StatusExecutionStatusId
Test CaseLast ModifiedLastUpdateDate
Test CaseTest Case NameName
Test CaseOwnerOwnerId
Test CaseReleaseReleaseId
Test CaseTest #TestCaseId
Test CasePriorityTestCasePriorityId
IncidentActual EffortActualEffort
IncidentFixed BuildBuildId
IncidentClosed OnClosedDate
Incident% CompleteCompletionPercent
IncidentComponentComponentIds
IncidentDetected OnCreationDate
IncidentDescriptionDescription
IncidentDetected ReleaseDetectedReleaseId
IncidentEst. EffortEstimatedEffort
IncidentIncident #IncidentId
IncidentStatusIncidentStatusId
IncidentTypeIncidentTypeId
IncidentLast ModifiedLastUpdateDate
IncidentNameName
IncidentDetected ByOpenerId
IncidentOwned ByOwnerId
IncidentPriorityPriorityId
IncidentProgressProgressId
IncidentProjected EffortProjectedEffort
IncidentRemaining EffortRemainingEffort
IncidentCommentsResolution
IncidentResolved ReleaseResolvedReleaseId
IncidentSeveritySeverityId
IncidentStarted OnStartDate
IncidentVerified ReleaseVerifiedReleaseId
ReleaseActiveActiveYn
ReleaseAvailable EffortAvailableEffort
ReleaseCommentsComments
ReleaseTest StatusCoverageId
ReleaseCreated OnCreationDate
ReleaseCreatorCreatorId
Release# Non Work DaysDaysNonWorking
ReleaseDescriptionDescription
ReleaseEnd DateEndDate
ReleaseIteration?IterationYn
ReleaseRelease NameName
ReleasePlan EffortPlannedEffort
ReleaseTask ProgressProgressId
ReleaseRelease #ReleaseId
Release# ResourcesResourceCount
ReleaseStart DateStartDate
ReleaseActual EffortTaskActualEffort
ReleaseTask EffortTaskEstimatedEffort
ReleaseProjected EffortTaskProjectedEffort
ReleaseRemaining EffortTaskRemainingEffort
ReleaseVersion #VersionNumber
Test RunAct. Dur.ActualDuration
Test RunAutomation HostAutomationHostId
Test RunBuildBuildId
Test RunExecution DateEndDate
Test RunEst. Dur.EstimatedDuration
Test RunStatusExecutionStatusId
Test RunTest Run NameName
Test RunReleaseReleaseId
Test RunRunner NameRunnerName
Test RunTesterTesterId
Test RunTest Run #TestRunId
Test RunTypeTestRunTypeId
Test RunTest SetTestSetId
TaskActual EffortActualEffort
TaskCommentsComments
Task% CompleteCompletionPercent
TaskComponentComponentId
TaskCreated OnCreationDate
TaskCreatorCreatorId
TaskDescriptionDescription
TaskEnd DateEndDate
TaskEst. EffortEstimatedEffort
TaskLast ModifiedLastUpdateDate
TaskTask NameName
TaskOwnerOwnerId
TaskProgressProgressId
TaskProj. EffortProjectedEffort
TaskReleaseReleaseId
TaskRemainingRemainingEffort
TaskRequirementRequirementId
TaskStart DateStartDate
TaskTask #TaskId
TaskPriorityTaskPriorityId
TaskStatusTaskStatusId
TaskTypeTaskTypeId
Test StepDescriptionDescription
Test StepStatusExecutionStatusId
Test StepExpected ResultExpectedResult
Test StepSample DataSampleData
Test SetAct. Dur.ActualDuration
Test SetAutomation HostAutomationHostId
Test SetCommentsComments
Test SetCreated OnCreationDate
Test SetCreatorCreatorId
Test SetDescriptionDescription
Test SetEst. Dur.EstimatedDuration
Test SetLast ExecutedExecutionDate
Test SetExecution StatusExecutionStatusId
Test SetLast ModifiedLastUpdateDate
Test SetTest Set NameName
Test SetOwnerOwnerId
Test SetPlanned DatePlannedDate
Test SetRecurrenceRecurrenceId
Test SetReleaseReleaseId
Test SetTest Run TypeTestRunTypeId
Test SetTest Set #TestSetId
Test SetStatusTestSetStatusId
Automation HostActiveActiveYn
Automation HostHost #AutomationHostId
Automation HostDescriptionDescription
Automation HostLast ModifiedLastUpdateDate
Automation HostHost NameName
Automation HostTokenToken
Requirement StepDescriptionDescription
Requirement StepStep #RequirementStepId
Attachments
Article Info
Last Updated: 9/11/2014
Article ID: KB88
# Views: 1649
Powered by KronoDesk v1.1.0.15 | © Copyright Inflectra Corporation 2011-2016 | Licensed to Inflectra Corporation.